NetConnectionMap Struct Reference

Represents a network connection map. More...

Classes
struct	Iterator
	Iterator for traversing the connections in a NetConnectionMap. More...

Public Types
enum	EntryState
	Represents the state of an entry in the NetConnectionMap. More...

Public Member Functions
NetConnection *	Find (NetAddress address)
	Finds a connection by its address in the network peer group.
NetConnection *	Find (NetConnectionId id)
	Finds a connection by its ID in the network peer group.
NetConnection *	FindByIndex (int index)
	Gets a connection by its index in the network peer group.
NetConnection *	Insert (NetAddress address, byte[] uniqueId, out NetAddress remappedFrom)
	Inserts a new connection into the network peer group using the specified address and unique ID.
NetConnection *	Remap (NetAddress oldAddress, NetAddress newAddress)
	Remaps a connection from an old address to a new address.
bool	Remove (NetAddress address)
	Removes a connection from the network peer group by its address.
bool	TryFindByIndex (int index, out NetConnection *connection)
	Tries to get a connection by its index in the network peer group.

Static Public Member Functions
static NetConnectionMap *	Allocate (int capacity, short groupIndex, in NetConfig *config)
	Allocates and initializes a new NetConnectionMap with the specified capacity and group index.
static void	Dispose (ref NetConnectionMap *map, INetPeerGroupCallbacks callbacks)
	Disposes of the specified NetConnectionMap and its associated resources.

Properties
readonly NetConnection *	ConnectionsBuffer [get]
	Gets the buffer of connections.
readonly int	Count [get]
	Gets the count of used connections minus the free connections.
readonly int	CountUsed [get]
	Gets the count of used connections.
readonly bool	Full [get]
	Gets a value indicating whether the connection map is full.

Detailed Description

Represents a network connection map.

Member Enumeration Documentation

EntryState

enum EntryState

Represents the state of an entry in the NetConnectionMap.

Enumerator
None	The entry is not in use.
Free	The entry is free and available for use.
Used	The entry is currently in use.

Member Function Documentation

Allocate()

NetConnectionMap * Allocate ( int capacity, short groupIndex, in NetConfig * config )

static

Allocates and initializes a new NetConnectionMap with the specified capacity and group index.

Parameters

capacity	The number of connections the map can hold.
groupIndex	The group index associated with the connections.
config	The configuration settings for the network connections.

Returns

A pointer to the newly allocated NetConnectionMap.

Dispose()

void Dispose ( ref NetConnectionMap * map, INetPeerGroupCallbacks callbacks )

static

Disposes of the specified NetConnectionMap and its associated resources.

Parameters

map	A pointer to the NetConnectionMap to dispose.
callbacks	The callbacks to invoke during disposal.

Find() [1/2]

NetConnection * Find

(

NetAddress

address

)

Finds a connection by its address in the network peer group.

Parameters

address

The address of the connection to find.

Returns

A pointer to the connection if found, otherwise null.

Find() [2/2]

NetConnection * Find

(

NetConnectionId

id

)

Finds a connection by its ID in the network peer group.

Parameters

id	The ID of the connection to find.

Returns

A pointer to the connection if found, otherwise null.

FindByIndex()

NetConnection * FindByIndex

(

int

index

)

Gets a connection by its index in the network peer group.

Parameters

index

The index of the connection to retrieve.

Returns

A pointer to the connection if found, otherwise throws an IndexOutOfRangeException.

Exceptions

IndexOutOfRangeException

Thrown when the index is out of the usable capacity range.

Insert()

NetConnection * Insert	(	NetAddress	address,
		byte[]	uniqueId,
		out NetAddress	remappedFrom )

Inserts a new connection into the network peer group using the specified address and unique ID.

Parameters

address	The address of the connection to insert.
uniqueId	The unique ID of the connection to insert.
remappedFrom	The address an existing connection was moved away from, when the unique ID was already in use. Left as default on every other path. The caller owns releasing that address from NetPeer, which this map cannot reach.

Returns

A pointer to the newly inserted connection, or null if the connection is already in use or the capacity is full.

Remap()

NetConnection * Remap	(	NetAddress	oldAddress,
		NetAddress	newAddress )

Remaps a connection from an old address to a new address.

Parameters

oldAddress	The old address of the connection.
newAddress	The new address of the connection.

Returns

A pointer to the remapped connection, or null if the remapping failed.

Remove()

bool Remove

(

NetAddress

address

)

Removes a connection from the network peer group by its address.

Parameters

address

The address of the connection to remove.

Returns

True if the connection was successfully removed, otherwise false.

TryFindByIndex()

bool TryFindByIndex	(	int	index,
		out NetConnection *	connection )

Tries to get a connection by its index in the network peer group.

Parameters

index	The index of the connection to retrieve.
connection	Output parameter that will point to the connection if found.

Returns

True if the connection was found, otherwise false.