protocol-constants.h (2583B)
1/* 2 * Licensed to the Apache Software Foundation (ASF) under one 3 * or more contributor license agreements. See the NOTICE file 4 * distributed with this work for additional information 5 * regarding copyright ownership. The ASF licenses this file 6 * to you under the Apache License, Version 2.0 (the 7 * "License"); you may not use this file except in compliance 8 * with the License. You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, 13 * software distributed under the License is distributed on an 14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 * KIND, either express or implied. See the License for the 16 * specific language governing permissions and limitations 17 * under the License. 18 */ 19 20#ifndef GUAC_PROTOCOL_CONSTANTS_H 21#define GUAC_PROTOCOL_CONSTANTS_H 22 23/** 24 * Constants related to the Guacamole protocol. 25 * 26 * @file protocol-constants.h 27 */ 28 29/** 30 * This defines the overall protocol version that this build of libguac 31 * supports. The protocol version is used to provide compatibility between 32 * potentially different versions of Guacamole server and clients. The 33 * version number is a MAJOR_MINOR_PATCH version that matches the versioning 34 * used throughout the components of the Guacamole project. This version 35 * will not necessarily increment with the other components, unless additional 36 * functionality is introduced that affects compatibility. 37 * 38 * This version is passed by the __guac_protocol_send_args() function from the 39 * server to the client during the client/server handshake. 40 */ 41#define GUACAMOLE_PROTOCOL_VERSION "VERSION_1_5_0" 42 43/** 44 * The maximum number of bytes that should be sent in any one blob instruction 45 * to ensure the instruction does not exceed the maximum allowed instruction 46 * size. 47 * 48 * @see GUAC_INSTRUCTION_MAX_LENGTH 49 */ 50#define GUAC_PROTOCOL_BLOB_MAX_LENGTH 6048 51 52/** 53 * The name of the layer parameter defining the number of simultaneous points 54 * of contact supported by a layer. This parameter should be set to a non-zero 55 * value if the associated layer should receive touch events ("touch" 56 * instructions). 57 * 58 * This value specified for this parameter is advisory, and the client is not 59 * required to honor the declared level of touch support. Implementations are 60 * expected to safely handle or ignore any received touch events, regardless of 61 * the level of touch support declared. 62 * 63 * @see guac_protocol_send_set_int() 64 */ 65#define GUAC_PROTOCOL_LAYER_PARAMETER_MULTI_TOUCH "multi-touch" 66 67#endif 68