socket.h

Go to the documentation of this file.

/*
 * Copyright (C) 2013 Glyptodon LLC
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */


#ifndef _GUAC_SOCKET_H
#define _GUAC_SOCKET_H

#include "timestamp.h"

#include <pthread.h>
#include <stdint.h>
#include <unistd.h>

#define GUAC_SOCKET_OUTPUT_BUFFER_SIZE 8192

#define GUAC_SOCKET_KEEP_ALIVE_INTERVAL 5000

typedef struct guac_socket guac_socket;

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 int guac_socket_free_handler(guac_socket* socket);

typedef enum guac_socket_state {

    GUAC_SOCKET_OPEN,

    GUAC_SOCKET_CLOSED

} guac_socket_state;

struct guac_socket {

    void* data;

    guac_socket_read_handler* read_handler;

    guac_socket_write_handler* write_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 __written;

    char __out_buf[GUAC_SOCKET_OUTPUT_BUFFER_SIZE];

    char* __instructionbuf_unparsed_start;

    char* __instructionbuf_unparsed_end;

    char __instructionbuf[32768];

    int __threadsafe_instructions;

    pthread_mutex_t __instruction_write_lock;

    pthread_mutex_t __buffer_lock;

    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_threadsafe(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);

void guac_socket_update_buffer_begin(guac_socket* socket);

void guac_socket_update_buffer_end(guac_socket* socket);

guac_socket* guac_socket_open(int fd);

guac_socket* guac_socket_nest(guac_socket* parent, int index);

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