Net Struct Reference

Platform-specific network operations. More...

#include <platformNet.h>

Public Types
enum	Error {   NoError , WrongProtocolType , InvalidPacketProtocol , WouldBlock ,   NotASocket , UnknownError , NeedHostLookup }
enum	ConnectionState {   DNSResolved , DNSFailed , Connected , ConnectFailed ,   Disconnected }

Static Public Member Functions
static bool	init ()
static void	shutdown ()
static bool	openPort (S32 connectPort, bool doBind=true)
static NetSocket	getPort ()
static void	closePort ()
static Error	sendto (const NetAddress *address, const U8 *buffer, S32 bufferSize)
static NetSocket	openListenPort (U16 port, NetAddress::Type=NetAddress::IPAddress)
static NetSocket	openConnectTo (const char *stringAddress)
static void	closeConnectTo (NetSocket socket)
static Error	sendtoSocket (NetSocket socket, const U8 *buffer, S32 bufferSize, S32 *bytesWritten=NULL)
static bool	compareAddresses (const NetAddress *a1, const NetAddress *a2)
static Net::Error	stringToAddress (const char *addressString, NetAddress *address, bool hostLookup=true, int family=0)
static void	addressToString (const NetAddress *address, char addressString[256])
static NetSocket	openSocket ()
static Error	closeSocket (NetSocket socket)
static Error	send (NetSocket socket, const U8 *buffer, S32 bufferSize, S32 *outBytesWritten=NULL)
static Error	recv (NetSocket socket, U8 *buffer, S32 bufferSize, S32 *bytesRead)
static Error	connect (NetSocket socket, const NetAddress *address)
static Error	listen (NetSocket socket, S32 maxConcurrentListens)
static NetSocket	accept (NetSocket acceptSocket, NetAddress *remoteAddress)
static Error	bindAddress (const NetAddress &address, NetSocket socket, bool useUDP=false)
static Error	setBufferSize (NetSocket socket, S32 bufferSize)
static Error	setBroadcast (NetSocket socket, bool broadcastEnable)
static Error	setBlocking (NetSocket socket, bool blockingIO)
static Net::Error	getListenAddress (const NetAddress::Type type, NetAddress *address, bool forceDefaults=false)
	Gets the desired default listen address for a specified address type.
static void	getIdealListenAddress (NetAddress *address)
static void	enableMulticast ()
static void	disableMulticast ()
static bool	isMulticastEnabled ()
static bool	isAddressTypeAvailable (NetAddress::Type addressType)
static void	process ()

Static Public Attributes
static const S32	MaxPacketDataSize = MAXPACKETSIZE
static bool	smMulticastEnabled = true
static bool	smIpv4Enabled = true
static bool	smIpv6Enabled = false

Detailed Description

Platform-specific network operations.

Member Enumeration Documentation

ConnectionState

enum ConnectionState

Enumerator
DNSResolved
DNSFailed
Connected
ConnectFailed
Disconnected

Error

enum Error

Enumerator
NoError
WrongProtocolType
InvalidPacketProtocol
WouldBlock
NotASocket
UnknownError
NeedHostLookup

Member Function Documentation

accept()

NetSocket accept ( NetSocket  acceptSocket, NetAddress *  remoteAddress  )

static

addressToString()

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

static

bindAddress()

Net::Error bindAddress ( const NetAddress &  address, NetSocket  socket, bool  useUDP = false  )

static

closeConnectTo()

void closeConnectTo ( NetSocket  socket )

static

closePort()

void closePort ( )

static

closeSocket()

Net::Error closeSocket ( NetSocket  socket )

static

compareAddresses()

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

static

connect()

Net::Error connect ( NetSocket  socket, const NetAddress *  address  )

static

disableMulticast()

void disableMulticast ( )

static

enableMulticast()

void enableMulticast ( )

static

getIdealListenAddress()

void getIdealListenAddress ( NetAddress *  address )

static

getListenAddress()

Net::Error getListenAddress ( const NetAddress::Type  type, NetAddress *  address, bool  forceDefaults = false  )

static

Gets the desired default listen address for a specified address type.

getPort()

NetSocket getPort ( )

static

init()

bool init ( )

static

isAddressTypeAvailable()

bool isAddressTypeAvailable ( NetAddress::Type  addressType )

static

isMulticastEnabled()

bool isMulticastEnabled ( )

static

listen()

Net::Error listen ( NetSocket  socket, S32  maxConcurrentListens  )

static

openConnectTo()

NetSocket openConnectTo ( const char *  stringAddress )

static

openListenPort()

NetSocket openListenPort ( U16  port, NetAddress::Type  addressType = NetAddress::IPAddress  )

static

openPort()

bool openPort ( S32  connectPort, bool  doBind = true  )

static

openSocket()

NetSocket openSocket ( )

static

process()

void process ( )

static

recv()

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

static

send()

Net::Error send ( NetSocket  socket, const U8 *  buffer, S32  bufferSize, S32 *  outBytesWritten = NULL  )

static

sendto()

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

static

sendtoSocket()

Net::Error sendtoSocket ( NetSocket  socket, const U8 *  buffer, S32  bufferSize, S32 *  bytesWritten = NULL  )

static

setBlocking()

Net::Error setBlocking ( NetSocket  socket, bool  blockingIO  )

static

setBroadcast()

Net::Error setBroadcast ( NetSocket  socket, bool  broadcastEnable  )

static

setBufferSize()

Net::Error setBufferSize ( NetSocket  socket, S32  bufferSize  )

static

shutdown()

void shutdown ( )

static

stringToAddress()

Net::Error stringToAddress ( const char *  addressString, NetAddress *  address, bool  hostLookup = true, int  family = 0  )

static

Member Data Documentation

MaxPacketDataSize

const S32 MaxPacketDataSize = MAXPACKETSIZE

static

smIpv4Enabled

bool smIpv4Enabled = true

static

smIpv6Enabled

bool smIpv6Enabled = false

static

smMulticastEnabled

bool smMulticastEnabled = true

static

---

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

• platform/platformNet.h
• platform/platformNet.cpp