protocol.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_PROTOCOL_H
#define _GUAC_PROTOCOL_H

#include "layer-types.h"
#include "object-types.h"
#include "protocol-types.h"
#include "socket-types.h"
#include "stream-types.h"
#include "timestamp-types.h"

#include <cairo/cairo.h>
#include <stdarg.h>

/* CONTROL INSTRUCTIONS */

int guac_protocol_send_ack(guac_socket* socket, guac_stream* stream,
        const char* error, guac_protocol_status status);

int guac_protocol_send_args(guac_socket* socket, const char** args);

int guac_protocol_send_connect(guac_socket* socket, const char** args);

int guac_protocol_send_disconnect(guac_socket* socket);

int guac_protocol_send_error(guac_socket* socket, const char* error,
        guac_protocol_status status);

int guac_protocol_send_log(guac_socket* socket, const char* format, ...);

int vguac_protocol_send_log(guac_socket* socket, const char* format,
        va_list args);

int guac_protocol_send_mouse(guac_socket* socket, int x, int y);

int guac_protocol_send_nest(guac_socket* socket, int index,
        const char* data);

int guac_protocol_send_nop(guac_socket* socket);

int guac_protocol_send_ready(guac_socket* socket, const char* id);

int guac_protocol_send_set(guac_socket* socket, const guac_layer* layer,
        const char* name, const char* value);

int guac_protocol_send_select(guac_socket* socket, const char* protocol);

int guac_protocol_send_sync(guac_socket* socket, guac_timestamp timestamp);

/* OBJECT INSTRUCTIONS */

int guac_protocol_send_body(guac_socket* socket, const guac_object* object,
        const guac_stream* stream, const char* mimetype, const char* name);

int guac_protocol_send_filesystem(guac_socket* socket,
        const guac_object* object, const char* name);

int guac_protocol_send_undefine(guac_socket* socket,
        const guac_object* object);

/* MEDIA INSTRUCTIONS */

int guac_protocol_send_audio(guac_socket* socket, const guac_stream* stream,
        const char* mimetype);

int guac_protocol_send_file(guac_socket* socket, const guac_stream* stream,
        const char* mimetype, const char* name);

int guac_protocol_send_pipe(guac_socket* socket, const guac_stream* stream,
        const char* mimetype, const char* name);

int guac_protocol_send_blob(guac_socket* socket, const guac_stream* stream,
        const void* data, int count);

int guac_protocol_send_end(guac_socket* socket, const guac_stream* stream);

int guac_protocol_send_video(guac_socket* socket, const guac_stream* stream,
        const guac_layer* layer, const char* mimetype);

/* DRAWING INSTRUCTIONS */

int guac_protocol_send_arc(guac_socket* socket, const guac_layer* layer,
        int x, int y, int radius, double startAngle, double endAngle,
        int negative);

int guac_protocol_send_cfill(guac_socket* socket,
        guac_composite_mode mode, const guac_layer* layer,
        int r, int g, int b, int a);

int guac_protocol_send_clip(guac_socket* socket, const guac_layer* layer);

int guac_protocol_send_close(guac_socket* socket, const guac_layer* layer);

int guac_protocol_send_copy(guac_socket* socket, 
        const guac_layer* srcl, int srcx, int srcy, int w, int h,
        guac_composite_mode mode, const guac_layer* dstl, int dstx, int dsty);

int guac_protocol_send_cstroke(guac_socket* socket,
        guac_composite_mode mode, const guac_layer* layer,
        guac_line_cap_style cap, guac_line_join_style join, int thickness,
        int r, int g, int b, int a);

int guac_protocol_send_cursor(guac_socket* socket, int x, int y,
        const guac_layer* srcl, int srcx, int srcy, int w, int h);

int guac_protocol_send_curve(guac_socket* socket, const guac_layer* layer,
        int cp1x, int cp1y, int cp2x, int cp2y, int x, int y);

int guac_protocol_send_identity(guac_socket* socket, const guac_layer* layer);

int guac_protocol_send_lfill(guac_socket* socket,
        guac_composite_mode mode, const guac_layer* layer,
        const guac_layer* srcl);

int guac_protocol_send_line(guac_socket* socket, const guac_layer* layer,
        int x, int y);

int guac_protocol_send_lstroke(guac_socket* socket,
        guac_composite_mode mode, const guac_layer* layer,
        guac_line_cap_style cap, guac_line_join_style join, int thickness,
        const guac_layer* srcl);

int guac_protocol_send_img(guac_socket* socket, const guac_stream* stream,
        guac_composite_mode mode, const guac_layer* layer,
        const char* mimetype, int x, int y);

int guac_protocol_send_pop(guac_socket* socket, const guac_layer* layer);

int guac_protocol_send_push(guac_socket* socket, const guac_layer* layer);

int guac_protocol_send_rect(guac_socket* socket, const guac_layer* layer,
        int x, int y, int width, int height);

int guac_protocol_send_reset(guac_socket* socket, const guac_layer* layer);

int guac_protocol_send_start(guac_socket* socket, const guac_layer* layer,
        int x, int y);

int guac_protocol_send_transfer(guac_socket* socket, 
        const guac_layer* srcl, int srcx, int srcy, int w, int h,
        guac_transfer_function fn, const guac_layer* dstl, int dstx, int dsty);

int guac_protocol_send_transform(guac_socket* socket, 
        const guac_layer* layer,
        double a, double b, double c,
        double d, double e, double f);

/* LAYER INSTRUCTIONS */

int guac_protocol_send_dispose(guac_socket* socket, const guac_layer* layer);

int guac_protocol_send_distort(guac_socket* socket, 
        const guac_layer* layer,
        double a, double b, double c,
        double d, double e, double f);

int guac_protocol_send_move(guac_socket* socket, const guac_layer* layer,
        const guac_layer* parent, int x, int y, int z);

int guac_protocol_send_shade(guac_socket* socket, const guac_layer* layer,
        int a);

int guac_protocol_send_size(guac_socket* socket, const guac_layer* layer,
        int w, int h);

/* TEXT INSTRUCTIONS */

int guac_protocol_send_clipboard(guac_socket* socket, const guac_stream* stream,
        const char* mimetype);

int guac_protocol_send_name(guac_socket* socket, const char* name);

int guac_protocol_decode_base64(char* base64);

#endif