UdpKit.UdpSession Class Reference

Base class for a UDPKit session. This class represents a session that can be used as starting point for a connection when Direct IP connection is not available. More...

Public Member Functions
abstract UdpSession	Clone ()
	Clone this instance. More...

Properties
abstract int	ConnectionsCurrent [get, set]
	Gets the current total of connections. More...
abstract int	ConnectionsMax [get, set]
	Gets the max connections allowed on this session. More...
abstract bool	HasLan [get]
	Gets a value indicating whether this T:UdpKit.UdpSessionImpl has lan. More...
abstract bool	HasWan [get]
	Gets a value indicating whether this T:UdpKit.UdpSessionImpl has WAN Address. More...
abstract Byte[]	HostData [get, set]
	Arbitrary Object that can be set on the session. It's used to save the Session Token. Same as HostObject, but in byte array form. More...
abstract string	HostName [get, set]
	Gets the host name that is publishing this session. More...
abstract Object	HostObject [get, set]
	Arbitrary Object that can be set on the session. It's used to save the Session Token. More...
abstract Guid	Id [get, set]
	Gets the session identifier. More...
abstract bool	IsDedicatedServer [get, set]
	Gets a value indicating whether this T:UdpKit.UdpSessionImpl is dedicated server. More...
abstract UdpEndPoint	LanEndPoint [get, set]
	Gets the LAN end point of this Session. More...
abstract UdpSessionSource	Source [get, set]
	Gets the session source. More...
abstract UdpEndPoint	WanEndPoint [get, set]
	Gets the WAN end point of this Session. More...

Detailed Description

Base class for a UDPKit session. This class represents a session that can be used as starting point for a connection when Direct IP connection is not available.

Member Function Documentation

Clone()

abstract UdpSession UdpKit.UdpSession.Clone ( )

pure virtual

Clone this instance.

Returns

The clone.

Property Documentation

ConnectionsCurrent

abstract int UdpKit.UdpSession.ConnectionsCurrent

getset

Gets the current total of connections.

The connections current.

ConnectionsMax

abstract int UdpKit.UdpSession.ConnectionsMax

getset

Gets the max connections allowed on this session.

HasLan

abstract bool UdpKit.UdpSession.HasLan

get

Gets a value indicating whether this T:UdpKit.UdpSessionImpl has lan.

true if has lan; otherwise, false.

HasWan

abstract bool UdpKit.UdpSession.HasWan

get

Gets a value indicating whether this T:UdpKit.UdpSessionImpl has WAN Address.

true if has wan; otherwise, false.

HostData

abstract Byte [] UdpKit.UdpSession.HostData

getset

Arbitrary Object that can be set on the session. It's used to save the Session Token. Same as HostObject, but in byte array form.

HostName

abstract string UdpKit.UdpSession.HostName

getset

Gets the host name that is publishing this session.

HostObject

abstract Object UdpKit.UdpSession.HostObject

getset

Arbitrary Object that can be set on the session. It's used to save the Session Token.

Id

abstract Guid UdpKit.UdpSession.Id

getset

Gets the session identifier.

IsDedicatedServer

abstract bool UdpKit.UdpSession.IsDedicatedServer

getset

Gets a value indicating whether this T:UdpKit.UdpSessionImpl is dedicated server.

true if is dedicated server; otherwise, false.

LanEndPoint

abstract UdpEndPoint UdpKit.UdpSession.LanEndPoint

getset

Gets the LAN end point of this Session.

Source

abstract UdpSessionSource UdpKit.UdpSession.Source

getset

Gets the session source.

WanEndPoint

abstract UdpEndPoint UdpKit.UdpSession.WanEndPoint

getset

Gets the WAN end point of this Session.