summaryrefslogtreecommitdiff
path: root/common/networksystem
diff options
context:
space:
mode:
Diffstat (limited to 'common/networksystem')
-rw-r--r--common/networksystem/inetworkmessage.h134
-rw-r--r--common/networksystem/inetworksystem.h162
2 files changed, 296 insertions, 0 deletions
diff --git a/common/networksystem/inetworkmessage.h b/common/networksystem/inetworkmessage.h
new file mode 100644
index 0000000..152512e
--- /dev/null
+++ b/common/networksystem/inetworkmessage.h
@@ -0,0 +1,134 @@
+//========= Copyright Valve Corporation, All rights reserved. ============//
+//
+// Purpose: INetworkMessage interface
+//
+// $NoKeywords: $
+//===========================================================================//
+
+#ifndef INETWORKMESSAGE_H
+#define INETWORKMESSAGE_H
+
+#ifdef _WIN32
+#pragma once
+#endif
+
+#include "tier0/platform.h"
+#include "tier0/dbg.h"
+
+//-----------------------------------------------------------------------------
+// Forward declarations
+//-----------------------------------------------------------------------------
+class bf_read;
+class bf_write;
+class INetMsgHandler;
+class INetMessage;
+class INetChannel;
+
+
+//-----------------------------------------------------------------------------
+// First valid group number users of the network system can use
+//-----------------------------------------------------------------------------
+enum
+{
+ NETWORKSYSTEM_FIRST_GROUP = 1,
+};
+
+
+//-----------------------------------------------------------------------------
+// A network message
+//-----------------------------------------------------------------------------
+abstract_class INetworkMessage
+{
+public:
+ // Use these to setup who can hear whose voice.
+ // Pass in client indices (which are their ent indices - 1).
+ virtual void SetNetChannel(INetChannel * netchan) = 0; // netchannel this message is from/for
+ virtual void SetReliable( bool state ) = 0; // set to true if it's a reliable message
+
+ virtual bool ReadFromBuffer( bf_read &buffer ) = 0; // returns true if parsing was OK
+ virtual bool WriteToBuffer( bf_write &buffer ) = 0; // returns true if writing was OK
+
+ virtual bool IsReliable( void ) const = 0; // true, if message needs reliable handling
+
+ virtual int GetGroup( void ) const = 0; // returns net message group of this message
+ virtual int GetType( void ) const = 0; // returns module specific header tag eg svc_serverinfo
+ virtual const char *GetGroupName( void ) const = 0; // returns network message group name
+ virtual const char *GetName( void ) const = 0; // returns network message name, eg "svc_serverinfo"
+ virtual INetChannel *GetNetChannel( void ) const = 0;
+ virtual const char *ToString( void ) const = 0; // returns a human readable string about message content
+
+ virtual void Release() = 0;
+
+protected:
+ virtual ~INetworkMessage() {};
+};
+
+
+//-----------------------------------------------------------------------------
+// Helper utilities for clients to create messages
+//-----------------------------------------------------------------------------
+#define DECLARE_BASE_MESSAGE( group, msgtype, description ) \
+ public: \
+ virtual bool ReadFromBuffer( bf_read &buffer ); \
+ virtual bool WriteToBuffer( bf_write &buffer ); \
+ virtual const char *ToString() const { return description; } \
+ virtual int GetGroup() const { return group; } \
+ virtual const char *GetGroupName( void ) const { return #group; } \
+ virtual int GetType() const { return msgtype; } \
+ virtual const char *GetName() const { return #msgtype;}\
+
+
+//-----------------------------------------------------------------------------
+// Default empty base class for net messages
+//-----------------------------------------------------------------------------
+class CNetworkMessage : public INetworkMessage
+{
+public:
+ CNetworkMessage()
+ {
+ m_bReliable = true;
+ m_pNetChannel = NULL;
+ }
+
+ virtual void Release()
+ {
+ delete this;
+ }
+
+ virtual ~CNetworkMessage() {};
+
+ virtual void SetReliable( bool state )
+ {
+ m_bReliable = state;
+ }
+
+ virtual bool IsReliable() const
+ {
+ return m_bReliable;
+ }
+
+ virtual void SetNetChannel(INetChannel * netchan)
+ {
+ m_pNetChannel = netchan;
+ }
+
+ virtual bool Process()
+ {
+ // no handler set
+ Assert( 0 );
+ return false;
+ }
+
+ INetChannel *GetNetChannel() const
+ {
+ return m_pNetChannel;
+ }
+
+protected:
+ bool m_bReliable; // true if message should be send reliable
+ INetChannel *m_pNetChannel; // netchannel this message is from/for
+};
+
+
+#endif // INETWORKMESSAGE_H
+
diff --git a/common/networksystem/inetworksystem.h b/common/networksystem/inetworksystem.h
new file mode 100644
index 0000000..5a6d602
--- /dev/null
+++ b/common/networksystem/inetworksystem.h
@@ -0,0 +1,162 @@
+//========= Copyright Valve Corporation, All rights reserved. ============//
+//
+// Purpose:
+//
+//===========================================================================//
+
+#ifndef INETWORKSYSTEM_H
+#define INETWORKSYSTEM_H
+#ifdef _WIN32
+#pragma once
+#endif
+
+#include "tier0/platform.h"
+#include "appframework/IAppSystem.h"
+
+
+//-----------------------------------------------------------------------------
+// Forward declarations:
+//-----------------------------------------------------------------------------
+class INetworkMessageHandler;
+class INetworkMessage;
+class INetChannel;
+class INetworkMessageFactory;
+class bf_read;
+class bf_write;
+typedef struct netadr_s netadr_t;
+class CNetPacket;
+
+
+//-----------------------------------------------------------------------------
+// Default ports
+//-----------------------------------------------------------------------------
+enum
+{
+ NETWORKSYSTEM_DEFAULT_SERVER_PORT = 27001,
+ NETWORKSYSTEM_DEFAULT_CLIENT_PORT = 27002
+};
+
+
+//-----------------------------------------------------------------------------
+// This interface encompasses a one-way communication path between two
+//-----------------------------------------------------------------------------
+typedef int ConnectionHandle_t;
+
+enum ConnectionStatus_t
+{
+ CONNECTION_STATE_DISCONNECTED = 0,
+ CONNECTION_STATE_CONNECTING,
+ CONNECTION_STATE_CONNECTION_FAILED,
+ CONNECTION_STATE_CONNECTED,
+};
+
+
+//-----------------------------------------------------------------------------
+// This interface encompasses a one-way communication path between two machines
+//-----------------------------------------------------------------------------
+abstract_class INetChannel
+{
+public:
+// virtual INetworkMessageHandler *GetMsgHandler( void ) const = 0;
+ virtual const netadr_t &GetRemoteAddress( void ) const = 0;
+
+ // send a net message
+ // NOTE: There are special connect/disconnect messages?
+ virtual bool AddNetMsg( INetworkMessage *msg, bool bForceReliable = false ) = 0;
+// virtual bool RegisterMessage( INetworkMessage *msg ) = 0;
+
+ virtual ConnectionStatus_t GetConnectionState( ) = 0;
+
+/*
+ virtual ConnectTo( const netadr_t& to ) = 0;
+ virtual Disconnect() = 0;
+
+ virtual const netadr_t& GetLocalAddress() = 0;
+
+ virtual const netadr_t& GetRemoteAddress() = 0;
+*/
+};
+
+
+//-----------------------------------------------------------------------------
+// Network event types + structures
+//-----------------------------------------------------------------------------
+enum NetworkEventType_t
+{
+ NETWORK_EVENT_CONNECTED = 0,
+ NETWORK_EVENT_DISCONNECTED,
+ NETWORK_EVENT_MESSAGE_RECEIVED,
+};
+
+struct NetworkEvent_t
+{
+ NetworkEventType_t m_nType;
+};
+
+struct NetworkConnectionEvent_t : public NetworkEvent_t
+{
+ INetChannel *m_pChannel;
+};
+
+struct NetworkDisconnectionEvent_t : public NetworkEvent_t
+{
+ INetChannel *m_pChannel;
+};
+
+struct NetworkMessageReceivedEvent_t : public NetworkEvent_t
+{
+ INetChannel *m_pChannel;
+ INetworkMessage *m_pNetworkMessage;
+};
+
+
+//-----------------------------------------------------------------------------
+// Main interface for low-level networking (packet sending). This is a low-level interface
+//-----------------------------------------------------------------------------
+#define NETWORKSYSTEM_INTERFACE_VERSION "NetworkSystemVersion001"
+abstract_class INetworkSystem : public IAppSystem
+{
+public:
+ // Installs network message factories to be used with all connections
+ virtual bool RegisterMessage( INetworkMessage *msg ) = 0;
+
+ // Start, shutdown a server
+ virtual bool StartServer( unsigned short nServerListenPort = NETWORKSYSTEM_DEFAULT_SERVER_PORT ) = 0;
+ virtual void ShutdownServer( ) = 0;
+
+ // Process server-side network messages
+ virtual void ServerReceiveMessages() = 0;
+ virtual void ServerSendMessages() = 0;
+
+ // Start, shutdown a client
+ virtual bool StartClient( unsigned short nClientListenPort = NETWORKSYSTEM_DEFAULT_CLIENT_PORT ) = 0;
+ virtual void ShutdownClient( ) = 0;
+
+ // Process client-side network messages
+ virtual void ClientSendMessages() = 0;
+ virtual void ClientReceiveMessages() = 0;
+
+ // Connect, disconnect a client to a server
+ virtual INetChannel* ConnectClientToServer( const char *pServer, int nServerListenPort = NETWORKSYSTEM_DEFAULT_SERVER_PORT ) = 0;
+ virtual void DisconnectClientFromServer( INetChannel* pChan ) = 0;
+
+ // Event queue
+ virtual NetworkEvent_t *FirstNetworkEvent( ) = 0;
+ virtual NetworkEvent_t *NextNetworkEvent( ) = 0;
+
+ // Returns the local host name
+ virtual const char* GetLocalHostName( void ) const = 0;
+ virtual const char* GetLocalAddress( void ) const = 0;
+
+ /*
+ // NOTE: Server methods
+ // NOTE: There's only 1 client INetChannel ever
+ // There can be 0-N server INetChannels.
+ virtual INetChannel* CreateConnection( bool bIsClientConnection ) = 0;
+
+ // Add methods for setting unreliable payloads
+ */
+};
+
+
+#endif // INETWORKSYSTEM_H