Skip to main content
Version: 3.1.0

Class UdpClient

Netly, Udp client implementation

Assembly: Netly.dll
View Source
Declaration
public class UdpClient

Properties

IsOpened

Return true when connection is opened

View Source
Declaration
public bool IsOpened { get; }

Host

Host container

View Source
Declaration
public Host Host { get; }

UseConnection

Return true when connection is enabled (using ping)

View Source
Declaration
public bool UseConnection { get; }

Timeout

Return timeout value, is milliseconds

View Source
Declaration
public int Timeout { get; }

Fields

UUID

Unique User Identifier, only server-side client

View Source
Declaration
public readonly string UUID

Methods

Open(Host)

Open udp connection

View Source
Declaration
public void Open(Host host)
Parameters
TypeNameDescription
Netly.Core.HosthostEndpoint container

Close()

Close udp connection

View Source
Declaration
public void Close()

ToData(byte[])

Send raw buffer

View Source
Declaration
public void ToData(byte[] buffer)
Parameters
TypeNameDescription
System.Byte[]bufferbuffer

ToData(string)

Send raw buffer

View Source
Declaration
public void ToData(string buffer)
Parameters
TypeNameDescription
System.Stringbufferbuffer

ToEvent(string, byte[])

Send event (netly-event)

You can create event using:

Netly.Core.EventManager.Create(string name, byte[] data);

And you can verify is a buffer is event (netly-event) using:

// When name or data is null, it mean isn't event (netly-event) 
(string name, byte[] data) = Netly.Core.EventManager.Verify(byte[] data);
View Source
Declaration
public void ToEvent(string name, byte[] buffer)
Parameters
TypeNameDescription
System.Stringnamename of event
System.Byte[]bufferbuffer of event

ToEvent(string, string)

Send event (netly-event)

You can create event using:

Netly.Core.EventManager.Create(string name, byte[] data);

And you can verify is a buffer is event (netly-event) using:

// When name or data is null, it mean isn't event (netly-event) 
(string name, byte[] data) = Netly.Core.EventManager.Verify(byte[] data);
View Source
Declaration
public void ToEvent(string name, string buffer)
Parameters
TypeNameDescription
System.Stringnamename of event
System.Stringbufferbuffer of event

OnOpen(Action)

Callback will called when is connection opened

View Source
Declaration
public void OnOpen(Action callback)
Parameters
TypeNameDescription
System.Actioncallbackcallback

OnError(Action<Exception>)

Callback will called when connection isn't opened

View Source
Declaration
public void OnError(Action<Exception> callback)
Parameters
TypeNameDescription
System.Action<System.Exception>callbackcallback

OnClose(Action)

Callback will called when connection is closed

View Source
Declaration
public void OnClose(Action callback)
Parameters
TypeNameDescription
System.Actioncallbackcallback

OnData(Action<byte[]>)

Callback will called when receive raw data

View Source
Declaration
public void OnData(Action<byte[]> callback)
Parameters
TypeNameDescription
System.Action<System.Byte[]>callbackcallback

OnEvent(Action<string, byte[]>)

Callback will called when receive event (netly-event)

You can create event using:

Netly.Core.EventManager.Create(string name, byte[] data);

And you can verify is a buffer is event (netly-event) using:

// When name or data is null, it mean isn't event (netly-event) 
(string name, byte[] data) = Netly.Core.EventManager.Verify(byte[] data);
View Source
Declaration
public void OnEvent(Action<string, byte[]> callback)
Parameters
TypeNameDescription
System.Action<System.String,System.Byte[]>callbackcallback

OnModify(Action<Socket>)

Callback will called after create Socket Instance, and before open connection

You can use the socket for modify default values

View Source
Declaration
public void OnModify(Action<Socket> callback)
Parameters
TypeName
System.Action<System.Net.Sockets.Socket>callback