RoRnet.h

Go to the documentation of this file.

/*
    This file is part of Rigs of Rods
 
    Copyright 2007  Pierre-Michel Ricordel
    Copyright 2014+ Petr Ohlidal & contributors.
 
    Rigs of Rods is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; version 3 of the License.
 
    Rigs of Rods is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
 
#pragma once
 
#include "BitFlags.h"
 
 
namespace RoRnet {
 
#define RORNET_MAX_PEERS            64     
#define RORNET_MAX_MESSAGE_LENGTH   8192   
#define RORNET_LAN_BROADCAST_PORT   13000  
#define RORNET_MAX_USERNAME_LEN     40     
 
#define RORNET_VERSION              "RoRnet_2.45"
 
enum MessageType
{
    MSG2_HELLO  = 1025,                
    
    // Hello responses
    MSG2_FULL,                         
    MSG2_WRONG_PW,                     
    MSG2_WRONG_VER,                    
    MSG2_BANNED,                       
    MSG2_WELCOME,                      
 
    // Technical
    MSG2_VERSION,                      
    MSG2_SERVER_SETTINGS,              
    MSG2_USER_INFO,                    
    MSG2_MASTERINFO,                   
    MSG2_NETQUALITY,                   
 
    // Gameplay
    MSG2_GAME_CMD,                     
    MSG2_USER_JOIN,                    
    MSG2_USER_LEAVE,                   
    MSG2_UTF8_CHAT,                    
    MSG2_UTF8_PRIVCHAT,                
 
    // Stream functions
    MSG2_STREAM_REGISTER,              
    MSG2_STREAM_REGISTER_RESULT,       
    MSG2_STREAM_UNREGISTER,            
    MSG2_STREAM_DATA,                  
    MSG2_STREAM_DATA_DISCARDABLE,      
 
    MSG2_NO_RANK,                      
 
    // Legacy values (RoRnet_2.38 and earlier)
    MSG2_WRONG_VER_LEGACY = 1003,      
};
enum MessageType {…};
 
enum UserAuth
{
    AUTH_NONE   = 0,                   
    AUTH_ADMIN  = BITMASK(1),          
    AUTH_RANKED = BITMASK(2),          
    AUTH_MOD    = BITMASK(3),          
    AUTH_BOT    = BITMASK(4),          
    AUTH_BANNED = BITMASK(5)           
};
enum UserAuth {…};
 
enum Netmask
{
    NETMASK_HORN         = BITMASK(1), 
    NETMASK_POLICEAUDIO  = BITMASK(2), 
    NETMASK_PARTICLE     = BITMASK(3), 
    NETMASK_PBRAKE       = BITMASK(4), 
    NETMASK_TC_ACTIVE    = BITMASK(5), 
    NETMASK_ALB_ACTIVE   = BITMASK(6), 
    NETMASK_ENGINE_CONT  = BITMASK(7), 
    NETMASK_ENGINE_RUN   = BITMASK(8), 
 
    NETMASK_ENGINE_MODE_AUTOMATIC     = BITMASK(9), 
    NETMASK_ENGINE_MODE_SEMIAUTO      = BITMASK(10), 
    NETMASK_ENGINE_MODE_MANUAL        = BITMASK(11), 
    NETMASK_ENGINE_MODE_MANUAL_STICK  = BITMASK(12), 
    NETMASK_ENGINE_MODE_MANUAL_RANGES = BITMASK(13), 
};
enum Netmask {…};
 
enum Lightmask
{
    LIGHTMASK_CUSTOM1     = BITMASK(1),  
    LIGHTMASK_CUSTOM2     = BITMASK(2),  
    LIGHTMASK_CUSTOM3     = BITMASK(3),  
    LIGHTMASK_CUSTOM4     = BITMASK(4),  
    LIGHTMASK_CUSTOM5     = BITMASK(5),  
    LIGHTMASK_CUSTOM6     = BITMASK(6),  
    LIGHTMASK_CUSTOM7     = BITMASK(7),  
    LIGHTMASK_CUSTOM8     = BITMASK(8),  
    LIGHTMASK_CUSTOM9     = BITMASK(9),  
    LIGHTMASK_CUSTOM10    = BITMASK(10), 
 
    LIGHTMASK_HEADLIGHT   = BITMASK(11),
    LIGHTMASK_HIGHBEAMS   = BITMASK(12),
    LIGHTMASK_FOGLIGHTS   = BITMASK(13),
    LIGHTMASK_SIDELIGHTS  = BITMASK(14),
    LIGHTMASK_BRAKES      = BITMASK(15), 
    LIGHTMASK_REVERSE     = BITMASK(16), 
    LIGHTMASK_BEACONS     = BITMASK(17), 
    LIGHTMASK_BLINK_LEFT  = BITMASK(18), 
    LIGHTMASK_BLINK_RIGHT = BITMASK(19), 
    LIGHTMASK_BLINK_WARN  = BITMASK(20), 
};
enum Lightmask {…};
 
// Flags used only locally on client to filter and control incoming traffic.
enum PeerOptions
{
    PEEROPT_MUTE_CHAT     = BITMASK(1), 
    PEEROPT_MUTE_ACTORS   = BITMASK(2), 
    PEEROPT_HIDE_ACTORS   = BITMASK(3), 
};
enum PeerOptions {…};
 
// Used by client to display informative icons on MP player list.
enum class UiStreamsHealth
{
    INVALID = -1,                  
    MISMATCHES = 0,                
    ALL_OK = 1,                    
    IDLE = 2,                      
};
enum class UiStreamsHealth {…};
 
// -------------------------------- structs -----------------------------------
// Only use datatypes with defined binary sizes (avoid bool, int, wchar_t...)
// Prefer alignment to 4 or 2 bytes (put int32/float/etc. fields on top)
 
#pragma pack(push, 1)
 
struct Header                      
{
    uint32_t command;              
    int32_t  source;               
    uint32_t streamid;             
    uint32_t size;                 
};
struct Header                       {…};
 
struct StreamRegister              
{
    int32_t type;                  
    int32_t status;                
    int32_t origin_sourceid;       
    int32_t origin_streamid;       
    char    name[128];             
    char    data[128];             
};
struct StreamRegister               {…};
 
struct ActorStreamRegister         
{
    // RoRnet::StreamRegister: Common
    int32_t type;                  
    int32_t status;                
    int32_t origin_sourceid;       
    int32_t origin_streamid;       
    char    name[128];             
    // RoRnet::StreamRegister: Data buffer (128B)
    int32_t bufferSize;            
    int32_t time;                  
    char    skin[60];              
    char    sectionconfig[60];     
};
struct ActorStreamRegister          {…};
 
struct StreamUnRegister            //< sent to remove a stream
{
    uint32_t streamid;
};
struct StreamUnRegister            //< sent to remove a stream {…};
 
struct UserInfo
{
    uint32_t uniqueid;             
    int32_t  authstatus;           
    int32_t  slotnum;              
    int32_t  colournum;            
 
    char     username[RORNET_MAX_USERNAME_LEN]; 
    char     usertoken[40];        
    char     serverpassword[40];   
    char     language[10];         
    char     clientname[10];       
    char     clientversion[25];    
    char     clientGUID[40];       
    char     sessiontype[10];      
    char     sessionoptions[128];  
};
struct UserInfo {…};
 
struct VehicleState                  
{
    int32_t  time;                 
    float    engine_speed;         
    float    engine_force;         
    float    engine_clutch;        
    int32_t  engine_gear;          
    float    hydrodirstate;        
    float    brake;                
    float    wheelspeed;           
    BitMask_t flagmask;             
    BitMask_t lightmask;            
};
struct VehicleState                   {…};
 
struct ServerInfo
{
    char    protocolversion[20];   
    char    terrain[128];          
    char    servername[128];       
    uint8_t has_password;          
    char    info[4096];            
};
struct ServerInfo {…};
 
struct LegacyServerInfo
{
    char    protocolversion[20];   
};
struct LegacyServerInfo {…};
 
} // namespace RoRnet
 
 
#pragma pack(pop)