Class Client

Inheritance

System.Object

Client

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Pigeoneer

Assembly: Trail.dll

Syntax

public static class Client

Methods

Connect(String, UInt16, Boolean, Client.OnConnectCallback)

Connects to a Pigeoneer server and passes a new Connection to the callback if the result is not an error.

Declaration

public static void Connect(string hostname, ushort port, bool securely, Client.OnConnectCallback callback)

Parameters

Type	Name	Description
System.String	hostname	The hostname to connect to, i.e. 127.0.0.1 or bigrig42.cloud.com.
System.UInt16	port	The port the server is listening on.
System.Boolean	securely
Client.OnConnectCallback	callback	The callback.

RunLoopIteration()

Runs an iteration of the event loop, allowing Pigeoneer to process incoming messages and fire callbacks. This method is only necessary for native builds.On WebGL builds, calls to this method are simply ignored since the event loop is directly driven by the browser's event loop. Depending on your setup, your native builds should call this method once per frame (e.g.call from within the render loop).

Declaration

public static void RunLoopIteration()

Events

OnClose

Declaration

public static event Client.OnCloseCallback OnClose

Event Type

Type	Description
Client.OnCloseCallback