UDPConnection.GetConnection Method (ConnectionInfo, UDPOptions, SendReceiveOptions, Boolean, Boolean)

UDPConnection GetConnection Method (ConnectionInfo, UDPOptions, SendReceiveOptions, Boolean, Boolean)

NetworkComms.Net Help

Create a UDP connection with the provided connectionInfo and and sets the connection default SendReceiveOptions. If there is an existing connection that is returned instead. If a new connection is created it will be registered with NetworkComms and can be retrieved using GetExistingConnection(ConnectionInfo).

Namespace: NetworkCommsDotNet.Connections.UDP
Assembly: NetworkCommsDotNet (in NetworkCommsDotNet.dll) Version: 3.0.0.0 (3.0.0.0)

Syntax

C++

Copy to Clipboard Print

public static UDPConnection GetConnection(
	ConnectionInfo connectionInfo,
	UDPOptions level,
	SendReceiveOptions defaultSendReceiveOptions,
	bool listenForReturnPackets = true,
	bool establishIfRequired = true
)

public static UDPConnection GetConnection(
	ConnectionInfo connectionInfo,
	UDPOptions level,
	SendReceiveOptions defaultSendReceiveOptions,
	bool listenForReturnPackets = true,
	bool establishIfRequired = true
)

Parameters

connectionInfo: Type: NetworkCommsDotNet ConnectionInfo
ConnectionInfo to be used to create connection

level: Type: NetworkCommsDotNet.Connections.UDP UDPOptions
The UDP options to use for this connection

defaultSendReceiveOptions: Type: NetworkCommsDotNet SendReceiveOptions
The SendReceiveOptions to use as defaults for this connection

listenForReturnPackets (Optional): Type: System Boolean
If set to true will ensure that reply packets can be received

establishIfRequired (Optional): Type: System Boolean
Will establish the connection, triggering connection establish delegates if a new connection is returned

Return Value

Type: UDPConnection
Returns a UDPConnection