Protocol.h

// Copyright (c) 2013 by István Váradi
 
// This file is part of XPLRA, a remote-access plugin for X-Plane
 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
 
// 1. Redistributions of source code must retain the above copyright notice, this
//    list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
 
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
// ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
// The views and conclusions contained in the software and documentation are those
// of the authors and should not be interpreted as representing official policies,
// either expressed or implied, of the FreeBSD Project.
 
#ifndef XPLRA_PROTOCOL_H
#define XPLRA_PROTOCOL_H
//------------------------------------------------------------------------------
 
#include <cstdlib>
#include <inttypes.h>
 
//------------------------------------------------------------------------------
 
namespace xplra {
 
//------------------------------------------------------------------------------
 
class Protocol
{
public:
    static const uint8_t COMMAND_GET_SINGLE = 0x01;
 
    static const uint8_t COMMAND_SET_SINGLE = 0x02;
 
    static const uint8_t COMMAND_GET_MULTI = 0x03;
 
    static const uint8_t COMMAND_SET_MULTI = 0x04;
 
    static const uint8_t COMMAND_REGISTER_GET_MULTI = 0x11;
 
    static const uint8_t COMMAND_UNREGISTER_GET_MULTI = 0x12;
 
    static const uint8_t COMMAND_EXECUTE_GET_MULTI = 0x13;
 
    static const uint8_t COMMAND_REGISTER_SET_MULTI = 0x21;
 
    static const uint8_t COMMAND_UNREGISTER_SET_MULTI = 0x22;
 
    static const uint8_t COMMAND_EXECUTE_SET_MULTI = 0x23;
 
    static const uint8_t COMMAND_GET_VERSIONS = 0x31;
 
    static const uint8_t COMMAND_RELOAD_PLUGINS = 0x32;
 
    static const uint8_t COMMAND_SAVE_SITUATION = 0x33;
 
    static const uint8_t COMMAND_SHOW_MESSAGE = 0x41;
 
    static const uint8_t COMMAND_REGISTER_HOTKEYS = 0x51;
 
    static const uint8_t COMMAND_QUERY_HOTKEYS = 0x52;
 
    static const uint8_t COMMAND_UNREGISTER_HOTKEYS = 0x53;
 
    static const uint8_t TYPE_INT = 0x01;
 
    static const uint8_t TYPE_FLOAT = 0x02;
 
    static const uint8_t TYPE_DOUBLE = 0x03;
 
    static const uint8_t TYPE_FLOAT_ARRAY = 0x11;
 
    static const uint8_t TYPE_INT_ARRAY = 0x12;
 
    static const uint8_t TYPE_BYTE_ARRAY = 0x13;
 
    static const uint8_t RESULT_OK = 0x00;
 
    static const uint8_t RESULT_INVALID_COMMAND = 0x01;
 
    static const uint8_t RESULT_UNKNOWN_DATAREF = 0x02;
 
    static const uint8_t RESULT_INVALID_TYPE = 0x03;
 
    static const uint8_t RESULT_INVALID_LENGTH = 0x04;
 
    static const uint8_t RESULT_INVALID_OFFSET = 0x05;
 
    static const uint8_t RESULT_INVALID_COUNT = 0x06;
 
    static const uint8_t RESULT_INVALID_ID = 0x07;
 
    static const uint8_t RESULT_INVALID_DURATION = 0x08;
 
    static const uint8_t RESULT_OTHER_ERROR = 0xff;
 
    static const uint16_t HOTKEY_MODIFIER_SHIFT = 0x0100;
 
    static const uint16_t HOTKEY_MODIFIER_CONTROL = 0x0200;
 
    static const int MAX_LENGTH = 2048;
 
    static const size_t MAX_MULTI_COUNT = 1024;
 
    static constexpr float MAX_MESSAGE_DURATION = 5*60;
 
    static const size_t MAX_HOTKEY_COUNT = 128;
 
    static const int version = 30;
};
 
//------------------------------------------------------------------------------
 
} /* namespace xplra */
 
//------------------------------------------------------------------------------
#endif // XPLRA_PROTOCOL_H
 
// Local Variables:
// mode: C++
// c-basic-offset: 4
// indent-tabs-mode: nil
// End: