Class Socket

An ODIN socket, which handles the underlying native opaque socket handle. This abstraction provides a high-level interface for sending and receiving messages to and from a peer.

Declaration

public class Socket : ISocket, IDisposable

Implements:
OdinNative.Wrapper.ISocket, System.IDisposable

Properties

Id

Socket id

Declaration

public ulong Id { get; }

Info

Declaration

public NativeBindings.OdinSocketInfo Info { get; }

Label

Socket label

Declaration

public int Label { get; }

IsRemote

Socket ownership check

Declaration

public bool IsRemote { get; }

IsClosed

IsClosed

Declaration

public bool IsClosed { get; }

Parent

Default value null indicates root or not set

Declaration

public IPeer Parent { get; set; }

Room

Declaration

public IRoom Room { get; set; }

Methods

OnSocket(IRoom, SocketMessageEventArgs)

Forward on socket data

Declaration

public virtual void OnSocket(IRoom room, SocketMessageEventArgs args)

Parameters

Type	Name
OdinNative.Wrapper.IRoom	room
OdinNative.Wrapper.Socket.SocketMessageEventArgs	args

Create(IRoom, OdinSocketKind, uint, int, int)

Initialise and opens a socket

Declaration

public static Socket Create(IRoom room, NativeBindings.OdinSocketKind kind, uint targetPeerId, int label, int priority)

Returns

OdinNative.Wrapper.Socket.Socket: Socket object

Parameters

Type	Name	Description
OdinNative.Wrapper.IRoom	room	Room to open the socket in
OdinNative.Core.Imports.NativeBindings.OdinSocketKind	kind	Type of socket to open
System.UInt32	targetPeerId	remote peer id
System.Int32	label	socket name
System.Int32	priority	socket priority

GetBaseSocket<T>()

This will always return itself

Declaration

public T GetBaseSocket<T>() where T : ISocket

Returns

<T>

Type Parameters

• T

RefreshHandle(int)

Refresh the native socket handle and pull socket info

Declaration

public bool RefreshHandle(int peerId = -1)

Returns

System.Boolean: true on new handle

Parameters

Type	Name	Description
System.Int32	peerId	default (-1) uses the last remote peer id

Socket_OnMessageReceived(object, IRoom, byte[])

Declaration

public virtual void Socket_OnMessageReceived(object sender, IRoom room, byte[] message)

Parameters

Type	Name
System.Object	sender
OdinNative.Wrapper.IRoom	room
System.Byte[]	message

Open(OdinSocketKind, uint, int, int)

Declaration

public bool Open(NativeBindings.OdinSocketKind kind, uint targetPeerId, int label, int priority)

Returns

System.Boolean

Parameters

Type	Name
OdinNative.Core.Imports.NativeBindings.OdinSocketKind	kind
System.UInt32	targetPeerId
System.Int32	label
System.Int32	priority

GetSocketId()

Retrieves the socket id

Declaration

public ulong GetSocketId()

Returns

System.UInt64: socket id

GetSocketInfo()

Declaration

public NativeBindings.OdinSocketInfo GetSocketInfo()

Returns

OdinNative.Core.Imports.NativeBindings.OdinSocketInfo

Send(string)

Sends an utf8 string message to the peer

Declaration

public NativeBindings.OdinError Send(string message)

Returns

OdinNative.Core.Imports.NativeBindings.OdinError: OdinError

Parameters

Type	Name	Description
System.String	message	text message

Send(byte[])

Sends an arbitrary message to the peer

Declaration

public NativeBindings.OdinError Send(byte[] message)

Returns

OdinNative.Core.Imports.NativeBindings.OdinError: OdinError

Parameters

Type	Name	Description
System.Byte[]	message	arbitrary message

Reset()

Close the native socket. (native dispose) Therefore local socket can not send.

Declaration

public void Reset()

Dispose(bool)

On dispose will close the socket

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name
System.Boolean	disposing

~Socket()

Finalizer

Declaration

protected ~Socket()

Dispose()

On dispose will free the socket and all associated data

Declaration

public void Dispose()

Events

OnMessageReceived

Odin socket received message

Declaration

public event OnSocketMessageReceivedDelegate OnMessageReceived

Event Type

OdinNative.Wrapper.OnSocketMessageReceivedDelegate

Implements

• OdinNative.Wrapper.ISocket
• System.IDisposable