doc/libguac/socket-fntypes_8h_source.html

/*

 * Licensed to the Apache Software Foundation (ASF) under one

 * or more contributor license agreements.  See the NOTICE file

 * distributed with this work for additional information

 * regarding copyright ownership.  The ASF licenses this file

 * to you under the Apache License, Version 2.0 (the

 * "License"); you may not use this file except in compliance

 * with the License.  You may obtain a copy of the License at

 *

 *   http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing,

 * software distributed under the License is distributed on an

 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY

 * KIND, either express or implied.  See the License for the

 * specific language governing permissions and limitations

 * under the License.

 */


#ifndef _GUAC_SOCKET_FNTYPES_H

#define _GUAC_SOCKET_FNTYPES_H


#include "socket-types.h"


#include <unistd.h>


typedef ssize_t guac_socket_read_handler(guac_socket* socket,

        void* buf, size_t count);


typedef ssize_t guac_socket_write_handler(guac_socket* socket,

        const void* buf, size_t count);


typedef int guac_socket_select_handler(guac_socket* socket, int usec_timeout);


typedef ssize_t guac_socket_flush_handler(guac_socket* socket);


typedef void guac_socket_lock_handler(guac_socket* socket);


typedef void guac_socket_unlock_handler(guac_socket* socket);


typedef int guac_socket_free_handler(guac_socket* socket);


#endif


guac_socket_lock_handler
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...
Definition socket-fntypes.h:93

guac_socket_write_handler
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.
Definition socket-fntypes.h:56

guac_socket_read_handler
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.
Definition socket-fntypes.h:43

guac_socket_flush_handler
ssize_t guac_socket_flush_handler(guac_socket *socket)
Generic flush handler for socket flush operations.
Definition socket-fntypes.h:83

guac_socket_select_handler
int guac_socket_select_handler(guac_socket *socket, int usec_timeout)
Generic handler for socket select operations, similar to the POSIX select() function.
Definition socket-fntypes.h:70

guac_socket_free_handler
int guac_socket_free_handler(guac_socket *socket)
Generic handler for the closing of a socket, modeled after the standard POSIX close() function.
Definition socket-fntypes.h:113

guac_socket_unlock_handler
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...
Definition socket-fntypes.h:103

socket-types.h
Type definitions related to the guac_socket object.

guac_socket
The core I/O object of Guacamole.
Definition socket.h:39