Interface IArchipelagoSocketHelper

Namespace

Archipelago.MultiClient.Net.Helpers

Assembly

Archipelago.MultiClient.Net.dll

Provides access to the underlying websocket, so send or receive messages

public interface IArchipelagoSocketHelper

Properties

Connected

bool Connected { get; }

Property Value

bool

Uri

Uri Uri { get; }

Property Value

Uri

Methods

Connect()

void Connect()

Disconnect()

void Disconnect()

SendMultiplePackets(params ArchipelagoPacketBase[])

void SendMultiplePackets(params ArchipelagoPacketBase[] packets)

Parameters

packets ArchipelagoPacketBase[]

SendMultiplePackets(List<ArchipelagoPacketBase>)

void SendMultiplePackets(List<ArchipelagoPacketBase> packets)

Parameters

packets List<ArchipelagoPacketBase>

SendMultiplePacketsAsync(Action<bool>, params ArchipelagoPacketBase[])

void SendMultiplePacketsAsync(Action<bool> onComplete = null, params ArchipelagoPacketBase[] packets)

Parameters

onComplete Action<bool>

packets ArchipelagoPacketBase[]

SendMultiplePacketsAsync(List<ArchipelagoPacketBase>, Action<bool>)

void SendMultiplePacketsAsync(List<ArchipelagoPacketBase> packets, Action<bool> onComplete = null)

Parameters

packets List<ArchipelagoPacketBase>

onComplete Action<bool>

SendPacket(ArchipelagoPacketBase)

void SendPacket(ArchipelagoPacketBase packet)

Parameters

packet ArchipelagoPacketBase

SendPacketAsync(ArchipelagoPacketBase, Action<bool>)

void SendPacketAsync(ArchipelagoPacketBase packet, Action<bool> onComplete = null)

Parameters

packet ArchipelagoPacketBase

onComplete Action<bool>

Events

ErrorReceived

Handler for error on the socket or during parsing of the packets

event ArchipelagoSocketHelperDelagates.ErrorReceivedHandler ErrorReceived

Event Type

ArchipelagoSocketHelperDelagates.ErrorReceivedHandler

PacketReceived

Handler for recieved and sucsesfully parsed packages

event ArchipelagoSocketHelperDelagates.PacketReceivedHandler PacketReceived

Event Type

ArchipelagoSocketHelperDelagates.PacketReceivedHandler

PacketsSent

Handler for packets published to the websocket, called before the packet is handled by the server

event ArchipelagoSocketHelperDelagates.PacketsSentHandler PacketsSent

Event Type

ArchipelagoSocketHelperDelagates.PacketsSentHandler

SocketClosed

Handler for when the underlaying socket connection is closed

event ArchipelagoSocketHelperDelagates.SocketClosedHandler SocketClosed

Event Type

ArchipelagoSocketHelperDelagates.SocketClosedHandler

SocketOpened

Handler for when the underlaying socket connection is opened to the archipelago server

event ArchipelagoSocketHelperDelagates.SocketOpenedHandler SocketOpened

Event Type

ArchipelagoSocketHelperDelagates.SocketOpenedHandler