Objects of this class are what controls and handles Connections to the Host. More...

Public Member Functions
	Connection ()
	Create a new Connection Object.

Connection	Connect ()
	Connects The instance to the target host.

Connection	SetHost (string Host)
	Set's the connection host for this instance.

Connection	SetPort (int Port)
	Sets the connection host's port for this instance.

Connection	SetOnConnection (SimpleCB OnConnect)
	Sets The callbackto be called Upon Connection.

Connection	SetOnSNFFail (SimpleCB OnSNFFail)
	Sets The callbackto be called Upon failure of the SNF Protocol.

Connection	SetOnSocketFail (SocketExceptionCB OnSocketFail)
	Sets The callbackto be called Upon Socket Connection Failure.

Connection	SetOnException (ExceptionCB OnException)
	Sets The callbackto be called Upon Any Exception that is not.

Connection	SetOnTimeout (SimpleCB OnTimeout)
	Sets The callbackto be called Connection Timeout.

Connection	AwaitConnection (TimeSpan timeout)
	Block Until the instance is Connected.

Connection	AwaitConnection (int milisecondtimeout)
	Block Until the instance is Connected in Miliseconds.

void	Send (Request r)
	Sends the request through the connection instance.

Static Public Member Functions
static Connection	get ()
	Returns the Global Connection Instance.

static Connection	Instantiate (string host, int Port)
	Instantiates a new Global Connection Instance.

static Connection	Instantiate ()
	Instantiats a Global Connection instance.

static void	SetDefaultHost (string host)
	Changes The Default Host URL.

static void	SetDefaultPort (int port)
	Changes The Default Port.

static void	InstanceSend (Request R)
	Send a Request through the Global Connection Instance.

Properties
static bool	isInitialized `[get]`
	Returns if the Global Connection Instance ( See get ) is instatiated or not.

bool	isConnected `[get]`
	Returns if the Instance is currently Connected.

string	Host `[get]`
	Returns The Instance's Host URL.

int	Port `[get]`
	Returns The instance's connection port.

ClientInfo	ClientInfo `[get]`
	Returns ClientInfo of the Client.

bool	isInstanceInitialized `[get]`
	Returns if the instance is initialized or not.

Detailed Description

Objects of this class are what controls and handles Connections to the Host.

Constructor & Destructor Documentation

◆ Connection()

SNFClient.Connection.Connection ( )

inline

Create a new Connection Object.

Member Function Documentation

◆ get()

static Connection SNFClient.Connection.get ( )

static

Returns the Global Connection Instance.

Returns: The Global Connection | null if no instance was registred

◆ Instantiate() [1/2]

static Connection SNFClient.Connection.Instantiate	(	string	host,
		int	Port )

inlinestatic

Instantiates a new Global Connection Instance.

Parameters

host	The SNF host to Connect to
Port	The Port of the SNF host

Returns: The new Connection Instance

Exceptions

ClassUninitialized If OPCode was not Initialized

◆ Instantiate() [2/2]

static Connection SNFClient.Connection.Instantiate ( )

static

Instantiats a Global Connection instance.

Note: If you want to instantiate a non Global Connection Instance use Instantiate(string, int)

Returns: The Global Connection Instance

◆ SetDefaultHost()

static void SNFClient.Connection.SetDefaultHost ( string host )

static

Changes The Default Host URL.

Parameters

host	New Default SNF Host

◆ SetDefaultPort()

static void SNFClient.Connection.SetDefaultPort ( int port )

static

Changes The Default Port.

Parameters

port	New Default SNF Port

◆ InstanceSend()

static void SNFClient.Connection.InstanceSend ( Request R )

inlinestatic

Send a Request through the Global Connection Instance.

Parameters

R	Request to send

Exceptions

ClassInstanceUninitialized

If The Global Connection Instance is not instantiated

See also: Instantiate()

◆ Connect()

Connection SNFClient.Connection.Connect ( )

inline

Connects The instance to the target host.

Returns: Connection Instance

◆ SetHost()

Connection SNFClient.Connection.SetHost ( string Host )

inline

Set's the connection host for this instance.

Parameters

Host	The new connection host

Returns: Connection Instance

Exceptions

Exceptions.Connection.AlreadyConnected Cannot Change this variable when the connection has already connected

See also: SetDefaultHost(string)

◆ SetPort()

Connection SNFClient.Connection.SetPort ( int Port )

inline

Sets the connection host's port for this instance.

Parameters

Port	The new Conenction's Port

Returns: Connection Instance

Exceptions

Exceptions.Connection.AlreadyConnected Cannot Change this variable when the connection has already connected

See also: SetDefaultPort(int)

◆ SetOnConnection()

Connection SNFClient.Connection.SetOnConnection ( SimpleCB OnConnect )

inline

Sets The callbackto be called Upon Connection.

Parameters

OnConnect Callback to called

Returns: Connection Instance

Exceptions

Exceptions.Connection.AlreadyConnected Cannot Change this variable when the connection has already connected

◆ SetOnSNFFail()

Connection SNFClient.Connection.SetOnSNFFail ( SimpleCB OnSNFFail )

inline

Sets The callbackto be called Upon failure of the SNF Protocol.

Parameters

OnSNFFail Callback to called

Returns: Connection Instance

Exceptions

Exceptions.Connection.AlreadyConnected Cannot Change this variable when the connection has already connected

◆ SetOnSocketFail()

Connection SNFClient.Connection.SetOnSocketFail ( SocketExceptionCB OnSocketFail )

inline

Sets The callbackto be called Upon Socket Connection Failure.

Parameters

OnSocketFail Callback to called

Returns: Connection Instance

Exceptions

Exceptions.Connection.AlreadyConnected Cannot Change this variable when the connection has already connected

◆ SetOnException()

Connection SNFClient.Connection.SetOnException ( ExceptionCB OnException )

inline

Sets The callbackto be called Upon Any Exception that is not.

Parameters

OnException Callback to called

Returns: Connection Instance

Exceptions

Exceptions.Connection.AlreadyConnected Cannot Change this variable when the connection has already connected

◆ SetOnTimeout()

Connection SNFClient.Connection.SetOnTimeout ( SimpleCB OnTimeout )

inline

Sets The callbackto be called Connection Timeout.

Parameters

OnTimeout Callback to called

Returns: Connection Instance

Exceptions

Exceptions.Connection.AlreadyConnected Cannot Change this variable when the connection has already connected

◆ AwaitConnection() [1/2]

Connection SNFClient.Connection.AwaitConnection ( TimeSpan timeout )

inline

Block Until the instance is Connected.

Parameters

timeout Maximum Allowed Timeout

Returns: Connection Instance

Exceptions

InstanceUninitialized	Instance was not Initialized
Exceptions.Connection.NotConnecting	Instance was not connecting, Call this after Connect

◆ AwaitConnection() [2/2]

Connection SNFClient.Connection.AwaitConnection ( int milisecondtimeout )

inline

Block Until the instance is Connected in Miliseconds.

Parameters

milisecondtimeout Maximum Allowed Timeout in Miliseconds

Returns: Connection Instance

Exceptions

InstanceUninitialized	Instance was not Initialized
Exceptions.Connection.NotConnecting	Instance was not connecting, Call this after Connect

◆ Send()

void SNFClient.Connection.Send ( Request r )

inline

Sends the request through the connection instance.

Parameters

r	Request to be sent

Exceptions

InstanceUninitialized	Instance was not initialized
Exceptions.Connection.NotConnected	Instance was not connected

Property Documentation

◆ isInitialized

bool SNFClient.Connection.isInitialized

staticget

Returns if the Global Connection Instance ( See get ) is instatiated or not.

See also: Instantiate()

◆ isConnected

bool SNFClient.Connection.isConnected

get

Returns if the Instance is currently Connected.

◆ Host

string SNFClient.Connection.Host

get

Returns The Instance's Host URL.

◆ Port

int SNFClient.Connection.Port

get

Returns The instance's connection port.

◆ ClientInfo

ClientInfo SNFClient.Connection.ClientInfo

get

Returns ClientInfo of the Client.

See also: ClientInfo

◆ isInstanceInitialized

bool SNFClient.Connection.isInstanceInitialized

get

Returns if the instance is initialized or not.

Note: If instance is not Initialized, then instanciate a new one, as by default Any instantiated Connection object is initialized if no problem occured.

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

Connection.cs

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ Connection()

Member Function Documentation

◆ get()

◆ Instantiate() [1/2]

◆ Instantiate() [2/2]

◆ SetDefaultHost()

◆ SetDefaultPort()

◆ InstanceSend()

◆ Connect()

◆ SetHost()

◆ SetPort()

◆ SetOnConnection()

◆ SetOnSNFFail()

◆ SetOnSocketFail()

◆ SetOnException()

◆ SetOnTimeout()

◆ AwaitConnection() [1/2]

◆ AwaitConnection() [2/2]

◆ Send()

Property Documentation

◆ isInitialized

◆ isConnected

◆ Host

◆ Port

◆ ClientInfo

◆ isInstanceInitialized