____                _       __
    / __ )____  _____   | |     / /___ ___________
   / __  / __ \/ ___/   | | /| / / __ `/ ___/ ___/
  / /_/ / /_/ (__  )    | |/ |/ / /_/ / /  (__  )
 /_____/\____/____/     |__/|__/\__,_/_/  /____/

       A futuristic real-time strategy game.
          This file is part of Bos Wars.

(C) Copyright 2001-2007 by the Bos Wars and Stratagus Project. Distributed under the "GNU General Public License"

---

network.h

Go to the documentation of this file.

//     ____                _       __               
//    / __ )____  _____   | |     / /___ ___________
//   / __  / __ \/ ___/   | | /| / / __ `/ ___/ ___/
//  / /_/ / /_/ (__  )    | |/ |/ / /_/ / /  (__  ) 
// /_____/\____/____/     |__/|__/\__,_/_/  /____/  
//                                              
//       A futuristic real-time strategy game.
//          This file is part of Bos Wars.
//
//
//      (c) Copyright 1998-2007 by Lutz Sammer, Russell Smith, and Jimmy Salmon
//
//      This program 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; only version 2 of the License.
//
//      This program 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, write to the Free Software
//      Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
//      02111-1307, USA.

#ifndef __NETWORK_H__
#define __NETWORK_H__


/*----------------------------------------------------------------------------
--  Includes
----------------------------------------------------------------------------*/

#include "unit.h"
#include "net_lowlevel.h"

/*----------------------------------------------------------------------------
--  Defines
----------------------------------------------------------------------------*/

#define MaxNetworkCommands 9  

#define IsNetworkGame() (NetworkFildes != (Socket)-1)

/*----------------------------------------------------------------------------
--  Declarations
----------------------------------------------------------------------------*/

class CUnit;
class CUnitType;

enum _message_type_ {
    MessageNone,                   
    MessageInitHello,              
    MessageInitReply,              
    MessageInitConfig,             

    MessageSync,                   
    MessageSelection,              
    MessageQuit,                   
    MessageQuitAck,                
    MessageResend,                 

    MessageChat,                   
    MessageChatTerm,               

    MessageCommandStop,            
    MessageCommandStand,           
    MessageCommandFollow,          
    MessageCommandMove,            
    MessageCommandRepair,          
    MessageCommandAutoRepair,      
    MessageCommandAttack,          
    MessageCommandGround,          
    MessageCommandPatrol,          
    MessageCommandBoard,           
    MessageCommandUnload,          
    MessageCommandBuild,           
    MessageCommandDismiss,         
    MessageCommandResource,        
    MessageCommandReturn,          
    MessageCommandTrain,           
    MessageCommandCancelTrain,     

    MessageExtendedCommand,        

    // ATTN: __MUST__ be last due to spellid encoding!!!
    MessageCommandSpellCast        
};

enum _extended_message_type_ {
    ExtendedMessageDiplomacy,     
    ExtendedMessageSharedVision,  
};

class CNetworkCommand {
public:
    CNetworkCommand() : Unit(0), X(0), Y(0), Dest(0) {}
    void Clear() { this->Unit = this->X = this->Y = this->Dest = 0; }

    void Serialize(unsigned char *p) const;
    void Deserialize(unsigned char *p);
    static size_t Size() { return 2+2+2+2; }

    Uint16 Unit;         
    Uint16 X;            
    Uint16 Y;            
    Uint16 Dest;         
};

class CNetworkExtendedCommand {
public:
    CNetworkExtendedCommand() : ExtendedType(0), Arg1(0), Arg2(0), Arg3(0), Arg4(0) {}

    void Serialize(unsigned char *p);
    void Deserialize(unsigned char *p);
    static size_t Size() { return 1+1+2+2+2; }

    Uint8  ExtendedType;  
    Uint8  Arg1;          
    Uint16 Arg2;          
    Uint16 Arg3;          
    Uint16 Arg4;          
};

class CNetworkChat {
public:
    CNetworkChat() {
        Player = 0;
        memset(Text, 0, sizeof(Text));
    }

    void Serialize(unsigned char *p);
    void Deserialize(unsigned char *p);
    static size_t Size() { return 1+7; }

    Uint8 Player;   
    char  Text[7];  
};

typedef struct _network_selection_header_ {
    unsigned NumberSent : 6;   
    unsigned Add : 1;          
    unsigned Remove : 1;       
    unsigned char Type[MaxNetworkCommands];  
} NetworkSelectionHeader;

class CNetworkSelection {
public:
    CNetworkSelection() {
        memset(Unit, 0, sizeof(Unit));
    }

    void Serialize(unsigned char *p);
    void Deserialize(unsigned char *p);
    static size_t Size() { return 2*4; }

    Uint16 Unit[4];  
};

class CNetworkPacketHeader {
public:
    CNetworkPacketHeader() {
        Cycle = 0;
        memset(Type, 0, sizeof(Type));
    }

    void Serialize(unsigned char *p) const;
    void Deserialize(unsigned char *p);
    static size_t Size() { return 1 + 1 * MaxNetworkCommands; }

    Uint8 Cycle;                     
    Uint8 Type[MaxNetworkCommands];  
};

class CNetworkPacket {
public:
    unsigned char *Serialize(int numcommands) const;
    int Deserialize(unsigned char *p, unsigned int len);
    static size_t Size(int numcommands) {
        return CNetworkPacketHeader::Size() + numcommands * CNetworkCommand::Size();
    }

    CNetworkPacketHeader Header;  
    CNetworkCommand Command[MaxNetworkCommands];
};

/*----------------------------------------------------------------------------
--  Variables
----------------------------------------------------------------------------*/

extern int NetworkNumInterfaces;  
extern Socket NetworkFildes;      
extern int NetworkInSync;         
extern int NetworkUpdates;        
extern int NetworkLag;            
extern unsigned long NetworkStatus[PlayerMax];  
extern int NoRandomPlacementMultiplayer;        

/*----------------------------------------------------------------------------
--  Functions
----------------------------------------------------------------------------*/

extern void InitNetwork1(void);  
extern void InitNetwork2(void);  
extern void ExitNetwork1(void);  
extern void NetworkEvent(void);  
extern void NetworkSync(void);   
extern void NetworkQuit(void);   
extern void NetworkRecover(void);   
extern void NetworkCommands(void);  
extern void NetworkChatMessage(const std::string &msg);  

extern void NetworkSendCommand(int command, const CUnit *unit, int x,
    int y, const CUnit *dest, const CUnitType *type, int status);
extern void NetworkSendExtendedCommand(int command, int arg1, int arg2,
    int arg3, int arg4, int status);
extern void NetworkSendSelection(CUnit **units, int count);


#endif // !__NETWORK_H__

---