socket-fntypes.h File Reference

Function type definitions related to the guac_socket object. More...

Go to the source code of this file.

Typedefs
typedef ssize_t	guac_socket_read_handler(guac_socket *socket, void *buf, size_t count)
	Generic read handler for socket read operations, modeled after the standard POSIX read() function.
typedef ssize_t	guac_socket_write_handler(guac_socket *socket, const void *buf, size_t count)
	Generic write handler for socket write operations, modeled after the standard POSIX write() function.
typedef int	guac_socket_select_handler(guac_socket *socket, int usec_timeout)
	Generic handler for socket select operations, similar to the POSIX select() function.
typedef ssize_t	guac_socket_flush_handler(guac_socket *socket)
	Generic flush handler for socket flush operations.
typedef void	guac_socket_lock_handler(guac_socket *socket)
	When set within a guac_socket, a handler of this type will be called whenever exclusive access to the guac_socket is required, such as when guac_socket_instruction_begin() is called.
typedef void	guac_socket_unlock_handler(guac_socket *socket)
	When set within a guac_socket, a handler of this type will be called whenever exclusive access to the guac_socket is no longer required, such as when guac_socket_instruction_end() is called.
typedef int	guac_socket_free_handler(guac_socket *socket)
	Generic handler for the closing of a socket, modeled after the standard POSIX close() function.

Detailed Description

Function type definitions related to the guac_socket object.

Typedef Documentation

guac_socket_flush_handler

typedef ssize_t guac_socket_flush_handler(guac_socket *socket)

Generic flush handler for socket flush operations.

This function is not modeled after any POSIX function. When set within a guac_socket, a handler of this type will be called when guac_socket_flush() is called.

Parameters

socket

The guac_socket being flushed.

Returns

Zero on success, or non-zero if an error occurs during flush.

guac_socket_free_handler

typedef int guac_socket_free_handler(guac_socket *socket)

Generic handler for the closing of a socket, modeled after the standard POSIX close() function.

When set within a guac_socket, a handler of this type will be called when the socket is closed.

Parameters

socket

The guac_socket being closed.

Returns

Zero on success, or -1 if an error occurs.

guac_socket_lock_handler

typedef void guac_socket_lock_handler(guac_socket *socket)

When set within a guac_socket, a handler of this type will be called whenever exclusive access to the guac_socket is required, such as when guac_socket_instruction_begin() is called.

Parameters

socket

The guac_socket to which exclusive access is required.

guac_socket_read_handler

typedef ssize_t guac_socket_read_handler(guac_socket *socket, void *buf, size_t count)

Generic read handler for socket read operations, modeled after the standard POSIX read() function.

When set within a guac_socket, a handler of this type will be called when data needs to be read into the socket.

Parameters

socket	The guac_socket being read from.
buf	The arbitrary buffer we must populate with data.
count	The maximum number of bytes to read into the buffer.

Returns

The number of bytes read, or -1 if an error occurs.

guac_socket_select_handler

typedef int guac_socket_select_handler(guac_socket *socket, int usec_timeout)

Generic handler for socket select operations, similar to the POSIX select() function.

When guac_socket_select() is called on a guac_socket, its guac_socket_select_handler will be invoked, if defined.

Parameters

socket	The guac_socket being selected.
usec_timeout	The maximum number of microseconds to wait for data, or -1 to potentially wait forever.

Returns

Positive on success, zero if the timeout elapsed and no data is available, negative on error.

guac_socket_unlock_handler

typedef void guac_socket_unlock_handler(guac_socket *socket)

When set within a guac_socket, a handler of this type will be called whenever exclusive access to the guac_socket is no longer required, such as when guac_socket_instruction_end() is called.

Parameters

socket

The guac_socket to which exclusive access is no longer required.

guac_socket_write_handler

typedef ssize_t guac_socket_write_handler(guac_socket *socket, const void *buf, size_t count)

Generic write handler for socket write operations, modeled after the standard POSIX write() function.

When set within a guac_socket, a handler of this type will be called when data needs to be written to the socket.

Parameters

socket	The guac_socket being written to.
buf	The arbitrary buffer containing data to be written.
count	The maximum number of bytes to written to the buffer.

Returns

The number of bytes written, or -1 if an error occurs.