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

#include <stdarg.h>

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

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

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

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