Torque Game Engine Documentation
TGE Version 1.5.2

Net Struct Reference

#include <platform.h>

Public Types

enum Error {
  NoError,
  WrongProtocolType,
  InvalidPacketProtocol,
  WouldBlock,
  NotASocket,
  UnknownError
}

enum Protocol {
  UDPProtocol,
  IPXProtocol,
  TCPProtocol
}

Static Public Member Functions

static bool init ()

static void shutdown ()

static bool openPort (S32 connectPort)

static void closePort ()

static Error sendto (const NetAddress *address, const U8 *buffer, S32 bufferSize)

static NetSocket openListenPort (U16 port)

static NetSocket openConnectTo (const char *stringAddress)

static void closeConnectTo (NetSocket socket)

static Error sendtoSocket (NetSocket socket, const U8 *buffer, S32 bufferSize)

static void process ()

static bool compareAddresses (const NetAddress *a1, const NetAddress *a2)

static bool stringToAddress (const char *addressString, NetAddress *address)

static void addressToString (const NetAddress *address, char addressString[256])

static NetSocket openSocket ()

static Error closeSocket (NetSocket socket)

static Error connect (NetSocket socket, const NetAddress *address)

static Error listen (NetSocket socket, S32 maxConcurrentListens)

static NetSocket accept (NetSocket acceptSocket, NetAddress *remoteAddress)

static Error bind (NetSocket socket, U16 port)

static Error setBufferSize (NetSocket socket, S32 bufferSize)

static Error setBroadcast (NetSocket socket, bool broadcastEnable)

static Error setBlocking (NetSocket socket, bool blockingIO)

static Error send (NetSocket socket, const U8 *buffer, S32 bufferSize)

static Error recv (NetSocket socket, U8 *buffer, S32 bufferSize, S32 *bytesRead)

Member Enumeration Documentation

enum Net::Error

Enumerator:

NoError
WrongProtocolType
InvalidPacketProtocol
WouldBlock
NotASocket
UnknownError

enum Net::Protocol

Enumerator:

UDPProtocol
IPXProtocol
TCPProtocol

Member Function Documentation

static bool Net::init ( ) [static]

static void Net::shutdown ( ) [static]

static bool Net::openPort ( S32 connectPort ) [static]

static void Net::closePort ( ) [static]

static Error Net::sendto	(	const NetAddress *	address,
		const U8 *	buffer,
		S32	bufferSize
	)			`[static]`

static NetSocket Net::openListenPort ( U16 port ) [static]

static NetSocket Net::openConnectTo ( const char * stringAddress ) [static]

static void Net::closeConnectTo ( NetSocket socket ) [static]

static Error Net::sendtoSocket	(	NetSocket	socket,
		const U8 *	buffer,
		S32	bufferSize
	)			`[static]`

static void Net::process ( ) [static]

static bool Net::compareAddresses	(	const NetAddress *	a1,
		const NetAddress *	a2
	)			`[static]`

static bool Net::stringToAddress	(	const char *	addressString,
		NetAddress *	address
	)			`[static]`

static void Net::addressToString	(	const NetAddress *	address,
		char	addressString[256]
	)			`[static]`

static NetSocket Net::openSocket ( ) [static]

static Error Net::closeSocket ( NetSocket socket ) [static]

static Error Net::connect	(	NetSocket	socket,
		const NetAddress *	address
	)			`[static]`

static Error Net::listen	(	NetSocket	socket,
		S32	maxConcurrentListens
	)			`[static]`

static NetSocket Net::accept	(	NetSocket	acceptSocket,
		NetAddress *	remoteAddress
	)			`[static]`

static Error Net::bind	(	NetSocket	socket,
		U16	port
	)			`[static]`

static Error Net::setBufferSize	(	NetSocket	socket,
		S32	bufferSize
	)			`[static]`

static Error Net::setBroadcast	(	NetSocket	socket,
		bool	broadcastEnable
	)			`[static]`

static Error Net::setBlocking	(	NetSocket	socket,
		bool	blockingIO
	)			`[static]`

static Error Net::send	(	NetSocket	socket,
		const U8 *	buffer,
		S32	bufferSize
	)			`[static]`

static Error Net::recv	(	NetSocket	socket,
		U8 *	buffer,
		S32	bufferSize,
		S32 *	bytesRead
	)			`[static]`