Skip to content

Latest commit

 

History

History
48 lines (29 loc) · 1.08 KB

socket_create.md

File metadata and controls

48 lines (29 loc) · 1.08 KB

zx_socket_create

NAME

socket_create - create a socket

SYNOPSIS

#include <zircon/syscalls.h>

zx_status_t zx_socket_create(uint32_t options,
                             zx_handle_t* out0, zx_handle_t* out1);

DESCRIPTION

socket_create() creates a socket, a connected pair of bidirectional stream transports, that can move only data, and that have a maximum capacity.

Data written to one handle may be read from the opposite.

The options must set either the ZX_SOCKET_STREAM or ZX_SOCKET_DATAGRAM flag. The ZX_SOCKET_HAS_CONTROL flag can also be set to enable the socket control plane.

RETURN VALUE

socket_create() returns ZX_OK on success. In the event of failure, one of the following values is returned.

ERRORS

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

ZX_ERR_NO_MEMORY (Temporary) Failure due to lack of memory.

LIMITATIONS

The maximum capacity is not currently set-able or get-able.

SEE ALSO

socket_read, socket_write.