main/syscalls/interrupt_trigger.md

<!--
Copyright 2023 The Fuchsia Authors. All rights reserved.
Use of this source code is governed by a BSD-style license that can be
found in the LICENSE file.

DO NOT EDIT. Generated from FIDL library zx by zither, a Fuchsia platform tool.

See //docs/reference/syscalls/README.md#documentation-generation for
regeneration instructions.
-->

# zx_interrupt_trigger

## Summary

Triggers a virtual interrupt object.

## Declaration

```c
#include <zircon/syscalls.h>

zx_status_t zx_interrupt_trigger(zx_handle_t handle,
                                 uint32_t options,
                                 zx_time_t timestamp);
```

## Description

`zx_interrupt_trigger()` is used to trigger a virtual interrupt interrupt object,
causing an interrupt message packet to arrive on the bound port, if it is bound
to a port, or [`zx_interrupt_wait()`] to return if it is waiting on this interrupt.

*options* must be zero.

*timestamp* is by default interpreted as a timestamp on `ZX_CLOCK_BOOT`. However, if
the interrupt was created with the `ZX_INTERRUPT_TIMESTAMP_MONO` option, then this
timestamp will be interpreted as a timestamp on `ZX_CLOCK_MONOTONIC`.

## Rights

*handle* must be of type `ZX_OBJ_TYPE_INTERRUPT` and have `ZX_RIGHT_SIGNAL`.

## Return value

`zx_interrupt_trigger()` returns `ZX_OK` on success. In the event
of failure, a negative error value is returned.

## Errors

`ZX_ERR_BAD_HANDLE` *handle* is an invalid handle.

`ZX_ERR_WRONG_TYPE` *handle* is not an interrupt object.

`ZX_ERR_BAD_STATE` *handle* is not a virtual interrupt.

`ZX_ERR_CANCELED`  [`zx_interrupt_destroy()`] was called on *handle*.

`ZX_ERR_ACCESS_DENIED` *handle* lacks `ZX_RIGHT_SIGNAL`.

`ZX_ERR_INVALID_ARGS` *options* is non-zero.

## See also

 - [`zx_handle_close()`]
 - [`zx_interrupt_ack()`]
 - [`zx_interrupt_bind()`]
 - [`zx_interrupt_create()`]
 - [`zx_interrupt_destroy()`]
 - [`zx_interrupt_wait()`]
 - [`zx_port_wait()`]

[`zx_handle_close()`]: handle_close.md
[`zx_interrupt_ack()`]: interrupt_ack.md
[`zx_interrupt_bind()`]: interrupt_bind.md
[`zx_interrupt_create()`]: interrupt_create.md
[`zx_interrupt_destroy()`]: interrupt_destroy.md
[`zx_interrupt_wait()`]: interrupt_wait.md
[`zx_port_wait()`]: port_wait.md