mx_channel_create

NAME

channel_create - create a channel

SYNOPSIS

#include <magenta/syscalls.h>

mx_status_t mx_channel_create(uint32_t options,
                              mx_handle_t* out0, mx_handle_t* out1);

DESCRIPTION

channel_create() creates a channel, a bi-directional datagram-style message transport capable of sending raw data bytes as well as handles from one side to the other.

Two handles are returned on success, providing access to both sides of the channel. Messages written to one handle may be read from the opposite.

The handles will have MX_RIGHT_TRANSFER (allowing them to be sent to another process via channel write), MX_RIGHT_WRITE (allowing messages to be written to them), and MX_RIGHT_READ (allowing messages to be read from them).

RETURN VALUE

channel_create() returns MX_OK on success. In the event of failure, a negative error value is returned.

ERRORS

MX_ERR_INVALID_ARGS out0 or out1 is an invalid pointer or NULL or options is any value other than 0.

MX_ERR_NO_MEMORY (Temporary) Failure due to lack of memory.

SEE ALSO

handle_close, handle_duplicate, handle_replace, object_wait_one, object_wait_many, channel_call, channel_read, channel_write.