Burger::NetworkModuleInfo_t Struct Reference

Structure to obtain information from a NetworkModule. More...

Public Attributes
const char *	m_pName
	Friendly name of the module (TCP/IP,AppleTalk,Bonjour,Steam,Xbox Live)
uint_t	m_uMaxPacketSize
	Largest size of a data packet this module can support.
uint_t	m_uMaxEndpoints
	Maximum number of endpoints this module can support at the same time, kNoEndpoints means no hosting, kUnlimitedEndpoints means unlimited only by system resources.
uint_t	m_uFlags
	Special flags for the module.
eNetworkProtocol	m_uType
	Unique ID code for the module's protocol.

Static Public Attributes
static const uint_t	kNoEndpoints = 0
	NetworkModule can't host.
static const uint_t	kUnlimitedEndpoints
	NetworkModule is only limited by system resources.
static const uint_t	kRequiresPolling
	NetworkModule requires polling to operate.
static const uint_t	kHasStreaming
	NetworkModule supports guaranteed streams.
static const uint_t	kHasDatagram
	NetworkModule supports datagrams.
static const uint_t	kHasExpedited
	NetworkModule supports priorities.

Detailed Description

Structure to obtain information from a NetworkModule.

---

This structure is returned by a call to NetworkModule::GetInfo(NetworkModuleInfo_t *) const.

It is filled in to describe the capabilities that the protocol offered by the module.

See also

NetworkModule or NetworkEndpoint

Member Data Documentation

kHasDatagram

const uint_t Burger::NetworkModuleInfo_t::kHasDatagram

static

Initial value:

=
 0x04U

NetworkModule supports datagrams.

kHasExpedited

const uint_t Burger::NetworkModuleInfo_t::kHasExpedited

static

Initial value:

=
 0x08U

NetworkModule supports priorities.

kHasStreaming

const uint_t Burger::NetworkModuleInfo_t::kHasStreaming

static

Initial value:

=
 0x02U

NetworkModule supports guaranteed streams.

kNoEndpoints

const uint_t Burger::NetworkModuleInfo_t::kNoEndpoints = 0

static

NetworkModule can't host.

kRequiresPolling

const uint_t Burger::NetworkModuleInfo_t::kRequiresPolling

static

Initial value:

=
 0x01U

NetworkModule requires polling to operate.

kUnlimitedEndpoints

const uint_t Burger::NetworkModuleInfo_t::kUnlimitedEndpoints

static

Initial value:

=
 0xFFFFFFFFU

NetworkModule is only limited by system resources.

or memory

m_pName

const char* Burger::NetworkModuleInfo_t::m_pName

Friendly name of the module (TCP/IP,AppleTalk,Bonjour,Steam,Xbox Live)

m_uFlags

uint_t Burger::NetworkModuleInfo_t::m_uFlags

Special flags for the module.

m_uMaxEndpoints

uint_t Burger::NetworkModuleInfo_t::m_uMaxEndpoints

Maximum number of endpoints this module can support at the same time, kNoEndpoints means no hosting, kUnlimitedEndpoints means unlimited only by system resources.

m_uMaxPacketSize

uint_t Burger::NetworkModuleInfo_t::m_uMaxPacketSize

Largest size of a data packet this module can support.

m_uType

eNetworkProtocol Burger::NetworkModuleInfo_t::m_uType

Unique ID code for the module's protocol.