client.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_CLIENT_H
#define _GUAC_CLIENT_H

#include "instruction.h"
#include "layer.h"
#include "pool.h"
#include "protocol.h"
#include "socket.h"
#include "stream.h"
#include "timestamp.h"

#include <stdarg.h>

#define GUAC_CLIENT_MAX_STREAMS 64

#define GUAC_CLIENT_CLOSED_STREAM_INDEX -1

typedef struct guac_client guac_client;

typedef int guac_client_handle_messages(guac_client* client);

typedef int guac_client_mouse_handler(guac_client* client, int x, int y, int button_mask);

typedef int guac_client_key_handler(guac_client* client, int keysym, int pressed);

typedef int guac_client_clipboard_handler(guac_client* client, char* copied);

typedef int guac_client_size_handler(guac_client* client,
        int width, int height);

typedef int guac_client_file_handler(guac_client* client, guac_stream* stream,
        char* mimetype, char* filename);

typedef int guac_client_pipe_handler(guac_client* client, guac_stream* stream,
        char* mimetype, char* name);

typedef int guac_client_blob_handler(guac_client* client, guac_stream* stream,
        void* data, int length);

typedef int guac_client_ack_handler(guac_client* client, guac_stream* stream,
        char* error, guac_protocol_status status);

typedef int guac_client_end_handler(guac_client* client, guac_stream* stream);

typedef int guac_client_audio_handler(guac_client* client, char* mimetype);

typedef int guac_client_video_handler(guac_client* client, char* mimetype);

typedef int guac_client_free_handler(guac_client* client);

typedef void guac_client_log_handler(guac_client* client, const char* format, va_list args); 

typedef int guac_client_init_handler(guac_client* client, int argc, char** argv);

#define GUAC_CLIENT_MOUSE_LEFT        0x01

#define GUAC_CLIENT_MOUSE_MIDDLE      0x02

#define GUAC_CLIENT_MOUSE_RIGHT       0x04

#define GUAC_CLIENT_MOUSE_SCROLL_UP   0x08

#define GUAC_CLIENT_MOUSE_SCROLL_DOWN 0x10

#define GUAC_BUFFER_POOL_INITIAL_SIZE 1024

typedef enum guac_client_state {

    GUAC_CLIENT_RUNNING,

    GUAC_CLIENT_STOPPING

} guac_client_state;

typedef struct guac_client_info {

    int optimal_width;

    int optimal_height;

    const char** audio_mimetypes;

    const char** video_mimetypes;

    int optimal_resolution;

} guac_client_info;

struct guac_client {

    guac_socket* socket;

    guac_client_state state;

    guac_timestamp last_received_timestamp;

    guac_timestamp last_sent_timestamp;

    guac_client_info info;

    void* data;

    guac_client_handle_messages* handle_messages;

    guac_client_mouse_handler* mouse_handler;

    guac_client_key_handler* key_handler;

    guac_client_clipboard_handler* clipboard_handler;

    guac_client_size_handler* size_handler;

    guac_client_file_handler* file_handler;

    guac_client_pipe_handler* pipe_handler;

    guac_client_ack_handler* ack_handler;

    guac_client_blob_handler* blob_handler;

    guac_client_end_handler* end_handler;

    guac_client_free_handler* free_handler;

    guac_client_log_handler* log_info_handler;

    guac_client_log_handler* log_error_handler;

    guac_pool* __buffer_pool;

    guac_pool* __layer_pool;

    guac_pool* __stream_pool;

    guac_stream __output_streams[GUAC_CLIENT_MAX_STREAMS];

    guac_stream __input_streams[GUAC_CLIENT_MAX_STREAMS];

};

guac_client* guac_client_alloc();

void guac_client_free(guac_client* client);

int guac_client_handle_instruction(guac_client* client, guac_instruction* instruction);

void guac_client_log_info(guac_client* client, const char* format, ...);

void guac_client_log_error(guac_client* client, const char* format, ...);

void vguac_client_log_info(guac_client* client, const char* format, va_list ap);

void vguac_client_log_error(guac_client* client, const char* format, va_list ap);

void guac_client_stop(guac_client* client);

void guac_client_abort(guac_client* client, guac_protocol_status status,
        const char* format, ...);

void vguac_client_abort(guac_client* client, guac_protocol_status status,
        const char* format, va_list ap);

guac_layer* guac_client_alloc_buffer(guac_client* client);

guac_layer* guac_client_alloc_layer(guac_client* client);

void guac_client_free_buffer(guac_client* client, guac_layer* layer);

void guac_client_free_layer(guac_client* client, guac_layer* layer);

guac_stream* guac_client_alloc_stream(guac_client* client);

void guac_client_free_stream(guac_client* client, guac_stream* stream);

extern const guac_layer* GUAC_DEFAULT_LAYER;

#endif