plugin-constants.h (2200B)
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_PLUGIN_CONSTANTS_H 21#define _GUAC_PLUGIN_CONSTANTS_H 22 23/** 24 * Constants related to client plugins. 25 * 26 * @file plugin-constants.h 27 */ 28 29/** 30 * String prefix which begins the library filename of all client plugins. 31 */ 32#define GUAC_PROTOCOL_LIBRARY_PREFIX "libguac-client-" 33 34/** 35 * String suffix which ends the library filename of all client plugins. 36 */ 37#define GUAC_PROTOCOL_LIBRARY_SUFFIX ".so" 38 39/** 40 * The maximum number of characters (COUNTING NULL TERMINATOR) to allow 41 * for protocol names within the library filename of client plugins. 42 */ 43#define GUAC_PROTOCOL_NAME_LIMIT 256 44 45/** 46 * The maximum number of characters (INCLUDING NULL TERMINATOR) that a 47 * character array containing the concatenation of the library prefix, 48 * protocol name, and suffix can contain, assuming the protocol name is 49 * limited to GUAC_PROTOCOL_NAME_LIMIT characters. 50 */ 51#define GUAC_PROTOCOL_LIBRARY_LIMIT ( \ 52 \ 53 sizeof(GUAC_PROTOCOL_LIBRARY_PREFIX) - 1 /* "libguac-client-" */ \ 54 + GUAC_PROTOCOL_NAME_LIMIT - 1 /* [up to 256 chars] */ \ 55 + sizeof(GUAC_PROTOCOL_LIBRARY_SUFFIX) - 1 /* ".so" */ \ 56 + 1 /* NULL terminator */ \ 57 \ 58) 59 60#endif 61