From c1b82503000659596e3b2700c1987d4f548c0ed9 Mon Sep 17 00:00:00 2001 From: Michael Jumper Date: Tue, 30 Jul 2019 13:26:03 -0700 Subject: [PATCH] GUACAMOLE-629: Move constants for Guacamole protocol to dedicated "*-constants.h" header. --- src/libguac/Makefile.am | 1 + src/libguac/guacamole/protocol-constants.h | 44 ++++++++++++++++++++++ src/libguac/guacamole/protocol.h | 15 +------- 3 files changed, 46 insertions(+), 14 deletions(-) create mode 100644 src/libguac/guacamole/protocol-constants.h diff --git a/src/libguac/Makefile.am b/src/libguac/Makefile.am index dc96a878..a6240802 100644 --- a/src/libguac/Makefile.am +++ b/src/libguac/Makefile.am @@ -54,6 +54,7 @@ libguacinc_HEADERS = \ guacamole/pool.h \ guacamole/pool-types.h \ guacamole/protocol.h \ + guacamole/protocol-constants.h \ guacamole/protocol-types.h \ guacamole/socket-constants.h \ guacamole/socket.h \ diff --git a/src/libguac/guacamole/protocol-constants.h b/src/libguac/guacamole/protocol-constants.h new file mode 100644 index 00000000..6ad7bf14 --- /dev/null +++ b/src/libguac/guacamole/protocol-constants.h @@ -0,0 +1,44 @@ +/* + * 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_CONSTANTS_H +#define GUAC_PROTOCOL_CONSTANTS_H + +/** + * Constants related to the Guacamole protocol. + * + * @file protocol-constants.h + */ + +/** + * This defines the overall protocol version that this build of libguac + * supports. The protocol version is used to provide compatibility between + * potentially different versions of Guacamole server and clients. The + * version number is a MAJOR_MINOR_PATCH version that matches the versioning + * used throughout the components of the Guacamole project. This version + * will not necessarily increment with the other components, unless additional + * functionality is introduced that affects compatibility. + * + * This version is passed by the __guac_protocol_send_args() function from the + * server to the client during the client/server handshake. + */ +#define GUACAMOLE_PROTOCOL_VERSION "VERSION_1_1_0" + +#endif + diff --git a/src/libguac/guacamole/protocol.h b/src/libguac/guacamole/protocol.h index fb8fbefe..2a5b138b 100644 --- a/src/libguac/guacamole/protocol.h +++ b/src/libguac/guacamole/protocol.h @@ -30,6 +30,7 @@ #include "layer-types.h" #include "object-types.h" +#include "protocol-constants.h" #include "protocol-types.h" #include "socket-types.h" #include "stream-types.h" @@ -38,20 +39,6 @@ #include #include -/** - * This defines the overall protocol version that this build of libguac - * supports. The protocol version is used to provide compatibility between - * potentially different versions of Guacamole server and clients. The - * version number is a MAJOR_MINOR_PATCH version that matches the versioning - * used throughout the components of the Guacamole project. This version - * will not necessarily increment with the other components, unless additional - * functionality is introduced that affects compatibility. - * - * This version is passed by the __guac_protocol_send_args() function from the - * server to the client during the client/server handshake. - */ -#define GUACAMOLE_PROTOCOL_VERSION "VERSION_1_1_0" - /* CONTROL INSTRUCTIONS */ /**