socket.h

Go to the documentation of this file.

/*
 * 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_H
#define _GUAC_SOCKET_H
 
#include "client-types.h"
#include "socket-constants.h"
#include "socket-fntypes.h"
#include "socket-types.h"
#include "timestamp-types.h"
 
#include <pthread.h>
#include <stdint.h>
#include <unistd.h>
 
struct guac_socket {
 
    void* data;
 
    guac_socket_read_handler* read_handler;
 
    guac_socket_write_handler* write_handler;
 
    guac_socket_flush_handler* flush_handler;
 
    guac_socket_lock_handler* lock_handler;
 
    guac_socket_unlock_handler* unlock_handler;
 
    guac_socket_select_handler* select_handler;
 
    guac_socket_free_handler* free_handler;
 
    guac_socket_state state;
 
    guac_timestamp last_write_timestamp;
 
    int __ready;
 
    int __ready_buf[3];
 
    int __keep_alive_enabled;
 
    pthread_t __keep_alive_thread;
 
};
 
guac_socket* guac_socket_alloc();
 
void guac_socket_free(guac_socket* socket);
 
void guac_socket_require_keep_alive(guac_socket* socket);
 
void guac_socket_instruction_begin(guac_socket* socket);
 
void guac_socket_instruction_end(guac_socket* socket);
 
guac_socket* guac_socket_open(int fd);
 
guac_socket* guac_socket_nest(guac_socket* parent, int index);
 
guac_socket* guac_socket_tee(guac_socket* primary, guac_socket* secondary);
 
guac_socket* guac_socket_broadcast(guac_client* client);
 
guac_socket* guac_socket_broadcast_pending(guac_client* client);
 
ssize_t guac_socket_write_int(guac_socket* socket, int64_t i);
 
ssize_t guac_socket_write_string(guac_socket* socket, const char* str);
 
ssize_t guac_socket_write_base64(guac_socket* socket, const void* buf, size_t count);
 
ssize_t guac_socket_write(guac_socket* socket, const void* buf, size_t count);
 
ssize_t guac_socket_read(guac_socket* socket, void* buf, size_t count);
 
ssize_t guac_socket_flush_base64(guac_socket* socket);
 
ssize_t guac_socket_flush(guac_socket* socket);
 
int guac_socket_select(guac_socket* socket, int usec_timeout);
 
#endif