Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | List of all members
TCP Class Reference

#include <tcp.h>

Public Types

enum  { CLIENT = 1 , SERVER = 2 }
 
enum  {
  OK , UNKNOWN , ISCONN , INPROGRESS ,
  ALREADY , AGAIN , ADDRINUSE , ADDRNOTAVAIL ,
  BADF , CONNREFUSED , INTR , NOTSOCK ,
  PIPE , WOULDBLOCK , INVAL , TIMEDOUT
}
 
enum  { CLIENT = 1 , SERVER = 2 }
 
enum  {
  OK , UNKNOWN , ISCONN , INPROGRESS ,
  ALREADY , AGAIN , ADDRINUSE , ADDRNOTAVAIL ,
  BADF , CONNREFUSED , INTR , NOTSOCK ,
  PIPE , WOULDBLOCK , INVAL , TIMEDOUT
}
 

Public Member Functions

 TCP (int newMode)
 
 TCP (int newMode, sint16 socket)
 
 ~TCP ()
 
bit8 Bind (uint32 IP, uint16 port, bit8 reuseAddr=FALSE)
 
bit8 Bind (char *Host, uint16 port, bit8 reuseAddr=FALSE)
 
sint32 GetMaxFD (void)
 
bit8 Connect (uint32 IP, uint16 port)
 
bit8 Connect (char *Host, uint16 port)
 
bit8 ConnectAsync (uint32 IP, uint16 port)
 
bit8 ConnectAsync (char *Host, uint16 port)
 
bit8 IsConnected (sint32 whichFD=0)
 
sint32 GetFD (void)
 
sint32 GetClientCount (void)
 
uint32 GetRemoteIP (sint32 whichFD=0)
 
uint16 GetRemotePort (sint32 whichFD=0)
 
sint32 GetConnection (void)
 
sint32 GetConnection (struct sockaddr *clientAddr)
 
void WaitWrite (sint32 whichFD=0)
 
bit8 CanWrite (sint32 whichFD=0)
 
sint32 Write (const uint8 *msg, uint32 len, sint32 whichFD=0)
 
sint32 WriteNB (uint8 *msg, uint32 len, sint32 whichFD=0)
 
sint32 EncapsulatedWrite (uint8 *msg, uint32 len, sint32 whichFD=0)
 
sint32 WriteString (char *msg, sint32 whichFD=0)
 
sint32 Printf (sint32 whichFD, const char *format,...)
 
sint32 Read (uint8 *msg, uint32 len, sint32 whichFD=0)
 
sint32 TimedRead (uint8 *msg, uint32 len, int seconds, sint32 whichFD=0)
 
sint32 Peek (uint8 *msg, uint32 len, sint32 whichFD=0)
 
sint32 EncapsulatedRead (uint8 *msg, uint32 len, sint32 whichFD=0)
 
char * Gets (char *string, int n, int whichFD=0)
 
int Wait (sint32 sec, sint32 usec, fd_set &returnSet, sint32 whichFD=0)
 
int Wait (sint32 sec, sint32 usec, fd_set &inputSet, fd_set &returnSet)
 
int GetStatus (void)
 
void ClearStatus (void)
 
void DisownSocket (void)
 
sint32 Close (sint32 whichFD=0)
 
sint32 CloseAll (void)
 
sint32 SetBlocking (bit8 block, sint32 whichFD=0)
 
bit8 SetInputDelay (sint32 delay)
 
bit8 SetOutputDelay (sint32 delay)
 
 TCP (int newMode)
 
 TCP (int newMode, sint16 socket)
 
 ~TCP ()
 
bit8 Bind (uint32 IP, uint16 port, bit8 reuseAddr=FALSE)
 
bit8 Bind (char *Host, uint16 port, bit8 reuseAddr=FALSE)
 
sint32 GetMaxFD (void)
 
bit8 Connect (uint32 IP, uint16 port)
 
bit8 Connect (char *Host, uint16 port)
 
bit8 ConnectAsync (uint32 IP, uint16 port)
 
bit8 ConnectAsync (char *Host, uint16 port)
 
bit8 IsConnected (sint32 whichFD=0)
 
sint32 GetFD (void)
 
sint32 GetClientCount (void)
 
uint32 GetRemoteIP (sint32 whichFD=0)
 
uint16 GetRemotePort (sint32 whichFD=0)
 
sint32 GetConnection (void)
 
sint32 GetConnection (struct sockaddr *clientAddr)
 
void WaitWrite (sint32 whichFD=0)
 
bit8 CanWrite (sint32 whichFD=0)
 
sint32 Write (const uint8 *msg, uint32 len, sint32 whichFD=0)
 
sint32 WriteNB (uint8 *msg, uint32 len, sint32 whichFD=0)
 
sint32 EncapsulatedWrite (uint8 *msg, uint32 len, sint32 whichFD=0)
 
sint32 WriteString (char *msg, sint32 whichFD=0)
 
sint32 Printf (sint32 whichFD, const char *format,...)
 
sint32 Read (uint8 *msg, uint32 len, sint32 whichFD=0)
 
sint32 TimedRead (uint8 *msg, uint32 len, int seconds, sint32 whichFD=0)
 
sint32 Peek (uint8 *msg, uint32 len, sint32 whichFD=0)
 
sint32 EncapsulatedRead (uint8 *msg, uint32 len, sint32 whichFD=0)
 
char * Gets (char *string, int n, int whichFD=0)
 
int Wait (sint32 sec, sint32 usec, fd_set &returnSet, sint32 whichFD=0)
 
int Wait (sint32 sec, sint32 usec, fd_set &inputSet, fd_set &returnSet)
 
int GetStatus (void)
 
void ClearStatus (void)
 
void DisownSocket (void)
 
sint32 Close (sint32 whichFD=0)
 
sint32 CloseAll (void)
 
sint32 SetBlocking (bit8 block, sint32 whichFD=0)
 
bit8 SetInputDelay (sint32 delay)
 
bit8 SetOutputDelay (sint32 delay)
 

Public Attributes

fd_set clientList
 

Detailed Description

Definition at line 68 of file tcp.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
CLIENT 
SERVER 

Definition at line 97 of file tcp.h.

◆ anonymous enum

anonymous enum
Enumerator
CLIENT 
SERVER 

Definition at line 97 of file tcp.h.

◆ anonymous enum

anonymous enum
Enumerator
OK 
UNKNOWN 
ISCONN 
INPROGRESS 
ALREADY 
AGAIN 
ADDRINUSE 
ADDRNOTAVAIL 
BADF 
CONNREFUSED 
INTR 
NOTSOCK 
PIPE 
WOULDBLOCK 
INVAL 
TIMEDOUT 

Definition at line 105 of file tcp.h.

◆ anonymous enum

anonymous enum
Enumerator
OK 
UNKNOWN 
ISCONN 
INPROGRESS 
ALREADY 
AGAIN 
ADDRINUSE 
ADDRNOTAVAIL 
BADF 
CONNREFUSED 
INTR 
NOTSOCK 
PIPE 
WOULDBLOCK 
INVAL 
TIMEDOUT 

Definition at line 105 of file tcp.h.

Constructor & Destructor Documentation

◆ TCP() [1/4]

TCP::TCP ( int newMode)

Definition at line 108 of file tcp.cpp.

◆ TCP() [2/4]

TCP::TCP ( int newMode,
sint16 socket )

Definition at line 123 of file tcp.cpp.

◆ ~TCP() [1/2]

TCP::~TCP ( )

Definition at line 155 of file tcp.cpp.

◆ TCP() [3/4]

TCP::TCP ( int newMode)

◆ TCP() [4/4]

TCP::TCP ( int newMode,
sint16 socket )

◆ ~TCP() [2/2]

TCP::~TCP ( )

Member Function Documentation

◆ Bind() [1/4]

bit8 TCP::Bind ( char * Host,
uint16 port,
bit8 reuseAddr = FALSE )

Definition at line 883 of file tcp.cpp.

◆ Bind() [2/4]

bit8 TCP::Bind ( char * Host,
uint16 port,
bit8 reuseAddr = FALSE )

◆ Bind() [3/4]

bit8 TCP::Bind ( uint32 IP,
uint16 port,
bit8 reuseAddr = FALSE )

Definition at line 905 of file tcp.cpp.

◆ Bind() [4/4]

bit8 TCP::Bind ( uint32 IP,
uint16 port,
bit8 reuseAddr = FALSE )

◆ CanWrite() [1/2]

bit8 TCP::CanWrite ( sint32 whichFD = 0)

Definition at line 858 of file tcp.cpp.

◆ CanWrite() [2/2]

bit8 TCP::CanWrite ( sint32 whichFD = 0)

◆ ClearStatus() [1/2]

void TCP::ClearStatus ( void )

Definition at line 1160 of file tcp.cpp.

◆ ClearStatus() [2/2]

void TCP::ClearStatus ( void )

◆ Close() [1/2]

sint32 TCP::Close ( sint32 whichFD = 0)

Definition at line 690 of file tcp.cpp.

◆ Close() [2/2]

sint32 TCP::Close ( sint32 whichFD = 0)

◆ CloseAll() [1/2]

sint32 TCP::CloseAll ( void )

Definition at line 660 of file tcp.cpp.

◆ CloseAll() [2/2]

sint32 TCP::CloseAll ( void )

◆ Connect() [1/4]

bit8 TCP::Connect ( char * Host,
uint16 port )

Definition at line 969 of file tcp.cpp.

◆ Connect() [2/4]

bit8 TCP::Connect ( char * Host,
uint16 port )

◆ Connect() [3/4]

bit8 TCP::Connect ( uint32 IP,
uint16 port )

Definition at line 987 of file tcp.cpp.

◆ Connect() [4/4]

bit8 TCP::Connect ( uint32 IP,
uint16 port )

◆ ConnectAsync() [1/4]

bit8 TCP::ConnectAsync ( char * Host,
uint16 port )

Definition at line 1055 of file tcp.cpp.

◆ ConnectAsync() [2/4]

bit8 TCP::ConnectAsync ( char * Host,
uint16 port )

◆ ConnectAsync() [3/4]

bit8 TCP::ConnectAsync ( uint32 IP,
uint16 port )

Definition at line 1074 of file tcp.cpp.

◆ ConnectAsync() [4/4]

bit8 TCP::ConnectAsync ( uint32 IP,
uint16 port )

◆ DisownSocket() [1/2]

void TCP::DisownSocket ( void )

Definition at line 679 of file tcp.cpp.

◆ DisownSocket() [2/2]

void TCP::DisownSocket ( void )

◆ EncapsulatedRead() [1/2]

sint32 TCP::EncapsulatedRead ( uint8 * msg,
uint32 len,
sint32 whichFD = 0 )

Definition at line 605 of file tcp.cpp.

◆ EncapsulatedRead() [2/2]

sint32 TCP::EncapsulatedRead ( uint8 * msg,
uint32 len,
sint32 whichFD = 0 )

◆ EncapsulatedWrite() [1/2]

sint32 TCP::EncapsulatedWrite ( uint8 * msg,
uint32 len,
sint32 whichFD = 0 )

fprintf(stderr,"\n\nENCAP SENT %d\n\n",bytesSent);

Definition at line 257 of file tcp.cpp.

◆ EncapsulatedWrite() [2/2]

sint32 TCP::EncapsulatedWrite ( uint8 * msg,
uint32 len,
sint32 whichFD = 0 )

◆ GetClientCount() [1/2]

sint32 TCP::GetClientCount ( void )
inline

Definition at line 150 of file tcp.h.

◆ GetClientCount() [2/2]

sint32 TCP::GetClientCount ( void )
inline

Definition at line 150 of file tcp.h.

◆ GetConnection() [1/4]

sint32 TCP::GetConnection ( struct sockaddr * clientAddr)

Definition at line 1224 of file tcp.cpp.

◆ GetConnection() [2/4]

sint32 TCP::GetConnection ( struct sockaddr * clientAddr)

◆ GetConnection() [3/4]

sint32 TCP::GetConnection ( void )

Definition at line 1204 of file tcp.cpp.

◆ GetConnection() [4/4]

sint32 TCP::GetConnection ( void )

◆ GetFD() [1/2]

int TCP::GetFD ( void )

Definition at line 161 of file tcp.cpp.

◆ GetFD() [2/2]

sint32 TCP::GetFD ( void )

◆ GetMaxFD() [1/2]

sint32 TCP::GetMaxFD ( void )

Definition at line 199 of file tcp.cpp.

◆ GetMaxFD() [2/2]

sint32 TCP::GetMaxFD ( void )

◆ GetRemoteIP() [1/2]

uint32 TCP::GetRemoteIP ( sint32 whichFD = 0)

Definition at line 378 of file tcp.cpp.

◆ GetRemoteIP() [2/2]

uint32 TCP::GetRemoteIP ( sint32 whichFD = 0)

◆ GetRemotePort() [1/2]

uint16 TCP::GetRemotePort ( sint32 whichFD = 0)

Definition at line 399 of file tcp.cpp.

◆ GetRemotePort() [2/2]

uint16 TCP::GetRemotePort ( sint32 whichFD = 0)

◆ Gets() [1/2]

char * TCP::Gets ( char * string,
int n,
int whichFD = 0 )

Definition at line 465 of file tcp.cpp.

◆ Gets() [2/2]

char * TCP::Gets ( char * string,
int n,
int whichFD = 0 )

◆ GetStatus() [1/2]

int TCP::GetStatus ( void )

Definition at line 1167 of file tcp.cpp.

◆ GetStatus() [2/2]

int TCP::GetStatus ( void )

◆ IsConnected() [1/2]

bit8 TCP::IsConnected ( sint32 whichFD = 0)

Definition at line 419 of file tcp.cpp.

◆ IsConnected() [2/2]

bit8 TCP::IsConnected ( sint32 whichFD = 0)

◆ Peek() [1/2]

sint32 TCP::Peek ( uint8 * msg,
uint32 len,
sint32 whichFD = 0 )

Definition at line 576 of file tcp.cpp.

◆ Peek() [2/2]

sint32 TCP::Peek ( uint8 * msg,
uint32 len,
sint32 whichFD = 0 )

◆ Printf() [1/2]

sint32 TCP::Printf ( sint32 whichFD,
const char * format,
... )

Definition at line 341 of file tcp.cpp.

◆ Printf() [2/2]

sint32 TCP::Printf ( sint32 whichFD,
const char * format,
... )

◆ Read() [1/2]

sint32 TCP::Read ( uint8 * msg,
uint32 len,
sint32 whichFD = 0 )

Definition at line 512 of file tcp.cpp.

◆ Read() [2/2]

sint32 TCP::Read ( uint8 * msg,
uint32 len,
sint32 whichFD = 0 )

◆ SetBlocking() [1/2]

sint32 TCP::SetBlocking ( bit8 block,
sint32 whichFD = 0 )

Definition at line 168 of file tcp.cpp.

◆ SetBlocking() [2/2]

sint32 TCP::SetBlocking ( bit8 block,
sint32 whichFD = 0 )

◆ SetInputDelay() [1/2]

bit8 TCP::SetInputDelay ( sint32 delay)
inline

Definition at line 194 of file tcp.h.

◆ SetInputDelay() [2/2]

bit8 TCP::SetInputDelay ( sint32 delay)
inline

Definition at line 194 of file tcp.h.

◆ SetOutputDelay() [1/2]

bit8 TCP::SetOutputDelay ( sint32 delay)
inline

Definition at line 195 of file tcp.h.

◆ SetOutputDelay() [2/2]

bit8 TCP::SetOutputDelay ( sint32 delay)
inline

Definition at line 195 of file tcp.h.

◆ TimedRead() [1/2]

sint32 TCP::TimedRead ( uint8 * msg,
uint32 len,
int seconds,
sint32 whichFD = 0 )

Definition at line 548 of file tcp.cpp.

◆ TimedRead() [2/2]

sint32 TCP::TimedRead ( uint8 * msg,
uint32 len,
int seconds,
sint32 whichFD = 0 )

◆ Wait() [1/4]

int TCP::Wait ( sint32 sec,
sint32 usec,
fd_set & inputSet,
fd_set & returnSet )

Definition at line 764 of file tcp.cpp.

◆ Wait() [2/4]

int TCP::Wait ( sint32 sec,
sint32 usec,
fd_set & inputSet,
fd_set & returnSet )

◆ Wait() [3/4]

int TCP::Wait ( sint32 sec,
sint32 usec,
fd_set & returnSet,
sint32 whichFD = 0 )

Definition at line 736 of file tcp.cpp.

◆ Wait() [4/4]

int TCP::Wait ( sint32 sec,
sint32 usec,
fd_set & returnSet,
sint32 whichFD = 0 )

◆ WaitWrite() [1/2]

void TCP::WaitWrite ( sint32 whichFD = 0)

Definition at line 826 of file tcp.cpp.

◆ WaitWrite() [2/2]

void TCP::WaitWrite ( sint32 whichFD = 0)

◆ Write() [1/2]

sint32 TCP::Write ( const uint8 * msg,
uint32 len,
sint32 whichFD = 0 )

Definition at line 210 of file tcp.cpp.

◆ Write() [2/2]

sint32 TCP::Write ( const uint8 * msg,
uint32 len,
sint32 whichFD = 0 )

◆ WriteNB() [1/2]

sint32 TCP::WriteNB ( uint8 * msg,
uint32 len,
sint32 whichFD = 0 )

Definition at line 233 of file tcp.cpp.

◆ WriteNB() [2/2]

sint32 TCP::WriteNB ( uint8 * msg,
uint32 len,
sint32 whichFD = 0 )

◆ WriteString() [1/2]

sint32 TCP::WriteString ( char * msg,
sint32 whichFD = 0 )

Definition at line 310 of file tcp.cpp.

◆ WriteString() [2/2]

sint32 TCP::WriteString ( char * msg,
sint32 whichFD = 0 )

Member Data Documentation

◆ clientList

fd_set TCP::clientList

Definition at line 128 of file tcp.h.

The documentation for this class was generated from the following files: