user.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_USER_H
#define _GUAC_USER_H
 
#include "client-types.h"
#include "layer-types.h"
#include "pool-types.h"
#include "socket-types.h"
#include "stream-types.h"
#include "timestamp-types.h"
#include "user-constants.h"
#include "user-fntypes.h"
#include "user-types.h"
 
#include <cairo/cairo.h>
 
#include <pthread.h>
#include <stdarg.h>
 
struct guac_user_info {
 
    int optimal_width;
 
    int optimal_height;
 
    const char** audio_mimetypes;
 
    const char** video_mimetypes;
 
    const char** image_mimetypes;
 
    int optimal_resolution;
 
    const char* timezone;
    
    guac_protocol_version protocol_version;
 
    const char* name;
 
};
 
struct guac_user {
 
    guac_client* client;
 
    guac_socket* socket;
 
    char* user_id;
 
    int owner;
 
    int active;
 
    guac_user* __prev;
 
    guac_user* __next;
 
    guac_timestamp last_received_timestamp;
 
    int last_frame_duration;
 
    int processing_lag;
 
    guac_user_info info;
 
    guac_pool* __stream_pool;
 
    guac_stream* __output_streams;
 
    guac_stream* __input_streams;
 
    guac_pool* __object_pool;
 
    guac_object* __objects;
 
    void* data;
 
    guac_user_mouse_handler* mouse_handler;
 
    guac_user_key_handler* key_handler;
 
    guac_user_clipboard_handler* clipboard_handler;
 
    guac_user_size_handler* size_handler;
 
    guac_user_file_handler* file_handler;
 
    guac_user_pipe_handler* pipe_handler;
 
    guac_user_ack_handler* ack_handler;
 
    guac_user_blob_handler* blob_handler;
 
    guac_user_end_handler* end_handler;
 
    guac_user_sync_handler* sync_handler;
 
    guac_user_leave_handler* leave_handler;
 
    guac_user_get_handler* get_handler;
 
    guac_user_put_handler* put_handler;
 
    guac_user_audio_handler* audio_handler;
 
    guac_user_argv_handler* argv_handler;
 
    guac_user_touch_handler* touch_handler;
 
};
 
guac_user* guac_user_alloc();
 
void guac_user_free(guac_user* user);
 
int guac_user_handle_connection(guac_user* user, int usec_timeout);
 
int guac_user_handle_instruction(guac_user* user, const char* opcode,
        int argc, char** argv);
 
guac_stream* guac_user_alloc_stream(guac_user* user);
 
void guac_user_free_stream(guac_user* user, guac_stream* stream);
 
void guac_user_stop(guac_user* user);
 
void guac_user_abort(guac_user* user, guac_protocol_status status,
        const char* format, ...);
 
void vguac_user_abort(guac_user* user, guac_protocol_status status,
        const char* format, va_list ap);
 
void guac_user_log(guac_user* user, guac_client_log_level level,
        const char* format, ...);
 
void vguac_user_log(guac_user* user, guac_client_log_level level,
        const char* format, va_list ap);
 
guac_object* guac_user_alloc_object(guac_user* user);
 
void guac_user_free_object(guac_user* user, guac_object* object);
 
void guac_user_stream_argv(guac_user* user, guac_socket* socket,
        const char* mimetype, const char* name, const char* value);
 
void guac_user_stream_png(guac_user* user, guac_socket* socket,
        guac_composite_mode mode, const guac_layer* layer, int x, int y,
        cairo_surface_t* surface);
 
void guac_user_stream_jpeg(guac_user* user, guac_socket* socket,
        guac_composite_mode mode, const guac_layer* layer, int x, int y,
        cairo_surface_t* surface, int quality);
 
void guac_user_stream_webp(guac_user* user, guac_socket* socket,
        guac_composite_mode mode, const guac_layer* layer, int x, int y,
        cairo_surface_t* surface, int quality, int lossless);
 
int guac_user_supports_msg(guac_user* user);
 
int guac_user_supports_required(guac_user* user);
 
int guac_user_supports_webp(guac_user* user);
 
char* guac_user_parse_args_string(guac_user* user, const char** arg_names,
        const char** argv, int index, const char* default_value);
 
int guac_user_parse_args_int(guac_user* user, const char** arg_names,
        const char** argv, int index, int default_value);
 
int guac_user_parse_args_boolean(guac_user* user, const char** arg_names,
        const char** argv, int index, int default_value);
 
#endif