socket.h

Go to the documentation of this file.

/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (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.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is libguac.
 *
 * The Initial Developer of the Original Code is
 * Michael Jumper.
 * Portions created by the Initial Developer are Copyright (C) 2010
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#ifndef _GUAC_SOCKET_H
#define _GUAC_SOCKET_H

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

#define GUAC_SOCKET_OUTPUT_BUFFER_SIZE 8192

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

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;
    
    int __ready;

    int __ready_buf[3];

    int __written;

    char __out_buf[GUAC_SOCKET_OUTPUT_BUFFER_SIZE];

    int __instructionbuf_parse_start;

    int __instructionbuf_size;

    int __instructionbuf_used_length;

    char* __instructionbuf;

    int __instructionbuf_elementc;

    char* __instructionbuf_elementv[64];

    int __threadsafe_instructions;

    pthread_mutex_t __instruction_write_lock;

    pthread_mutex_t __buffer_lock;

};

guac_socket* guac_socket_alloc();

void guac_socket_free(guac_socket* socket);

void guac_socket_require_threadsafe(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