user-constants.h (1915B)
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_USER_CONSTANTS_H 21#define _GUAC_USER_CONSTANTS_H 22 23/** 24 * Constants related to the Guacamole user structure, guac_user. 25 * 26 * @file user-constants.h 27 */ 28 29/** 30 * The character prefix which identifies a user ID. 31 */ 32#define GUAC_USER_ID_PREFIX '@' 33 34/** 35 * The maximum number of inbound or outbound streams supported by any one 36 * guac_user. 37 */ 38#define GUAC_USER_MAX_STREAMS 64 39 40/** 41 * The index of a closed stream. 42 */ 43#define GUAC_USER_CLOSED_STREAM_INDEX -1 44 45/** 46 * The maximum number of objects supported by any one guac_client. 47 */ 48#define GUAC_USER_MAX_OBJECTS 64 49 50/** 51 * The index of an object which has not been defined. 52 */ 53#define GUAC_USER_UNDEFINED_OBJECT_INDEX -1 54 55/** 56 * The stream name reserved for the root of a Guacamole protocol object. 57 */ 58#define GUAC_USER_OBJECT_ROOT_NAME "/" 59 60/** 61 * The mimetype of a stream containing a map of available stream names to their 62 * corresponding mimetypes. The root of a Guacamole protocol object is 63 * guaranteed to have this type. 64 */ 65#define GUAC_USER_STREAM_INDEX_MIMETYPE "application/vnd.glyptodon.guacamole.stream-index+json" 66 67#endif 68