VerticesEngine.Net.vxINetworkClientBackend Interface Reference

Provides an API interface for a common network interface to a specific backend implmenetation (such as SteamWorks API, Android API, Lidgren etc...) More...

Inheritance diagram for VerticesEngine.Net.vxINetworkClientBackend:

Public Member Functions
void	Initialise ()
	Initialises The Network Manager.
void	SendLocalDiscoverySignal (int port)
	Sends a discovery signal to find available servers. Note not all implementations need to specifiy a port.
void	SendDiscoverySignal (string ip, int port)
	Sends a discovery signal to find available servers. Note not all implementations need to specifiy a port.
void	Connect (string Address, int Port)
	Connect to the specified address and port with a given hail message.
void	Connect (string Address, int Port, vxINetMessageOutgoing hail)
	Connect to the specified address and port with a given hail message.
vxINetMessageOutgoing	CreateMessage ()
	The create message.
double	GetCurrentNetTime ()
	Returns the current Net Time for this implmentation.
void	Disconnect ()
	The disconnect.
vxINetMessageIncoming	ReadMessage ()
	The read message.
void	Recycle (vxINetMessageIncoming im)
	The recycle.
void	SendMessage (vxINetworkMessage gameMessage)
	The send message.
void	DebugDraw ()

Detailed Description

Provides an API interface for a common network interface to a specific backend implmenetation (such as SteamWorks API, Android API, Lidgren etc...)

Member Function Documentation

Connect() [1/2]

void VerticesEngine.Net.vxINetworkClientBackend.Connect	(	string	Address,
		int	Port )

Connect to the specified address and port with a given hail message.

Parameters

Address
Port

Connect() [2/2]

void VerticesEngine.Net.vxINetworkClientBackend.Connect	(	string	Address,
		int	Port,
		vxINetMessageOutgoing	hail )

Connect to the specified address and port with a given hail message.

Parameters

Address
Port
hail

CreateMessage()

vxINetMessageOutgoing VerticesEngine.Net.vxINetworkClientBackend.CreateMessage

(

)

The create message.

Returns

GetCurrentNetTime()

double VerticesEngine.Net.vxINetworkClientBackend.GetCurrentNetTime

(

)

Returns the current Net Time for this implmentation.

Returns

ReadMessage()

vxINetMessageIncoming VerticesEngine.Net.vxINetworkClientBackend.ReadMessage

(

)

The read message.

Returns

Recycle()

void VerticesEngine.Net.vxINetworkClientBackend.Recycle

(

vxINetMessageIncoming

im

)

The recycle.

Parameters

im

The im.

SendDiscoverySignal()

void VerticesEngine.Net.vxINetworkClientBackend.SendDiscoverySignal	(	string	ip,
		int	port )

Sends a discovery signal to find available servers. Note not all implementations need to specifiy a port.

Parameters

port

SendLocalDiscoverySignal()

void VerticesEngine.Net.vxINetworkClientBackend.SendLocalDiscoverySignal

(

int

port

)

Sends a discovery signal to find available servers. Note not all implementations need to specifiy a port.

Parameters

port

SendMessage()

void VerticesEngine.Net.vxINetworkClientBackend.SendMessage

(

vxINetworkMessage

gameMessage

)

The send message.

Parameters

gameMessage

The game message.

---

The documentation for this interface was generated from the following file:

• /github/workspace/src/VerticesEngine/src.shared/Net/Backends/vxINetworkClientBackend.cs