This is experimental documentation.
Declaration Syntax| C# | Visual Basic | Visual C++ |
public class SocketClient : IDisposable
Public Class SocketClient _ Implements IDisposable
public ref class SocketClient : IDisposable
Members| All Members | Constructors | Methods | Properties | Events | |
| Icon | Member | Description |
|---|---|---|
 | SocketClient()()()() |
Creates a new socket client.
|
| Close()()()() |
Closes the socket connection.
|
| Connect(String, Int32) |
Connects the socket client.
|
| Connect(String, Int32, String) |
Connects the new socket and binds it to the specified local ip.
|
 | Connect(String, Int32, String, AsyncCallback) | |
| Connect(String, Int32, ProxyType, String, Int32) | |
 | Connected |
This event is called when the socket connects.
|
| DataReceived |
This event is called when the socket is finished validating the received data.
|
| Disconnect()()()() |
Disconnects the socket client.
|
| Disconnected |
This event is called when a socket disconnects
|
| Dispose()()()() | |
| Equals(Object) | (Inherited from Object.) |
| Error |
This event is fired when there is any error exception that occurs in SocketClient
|
| Finalize()()()() | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| GetBytesReceived(IAsyncResult) |
Gets the bytes received from a socket, is used in method SocketDataArrival.
|
| GetDataLength()()()() |
This can be overridden to allow for different protocols. Gets the length of a data packet. (Default is BNLS)
|
| GetHashCode()()()() | Serves as a hash function for a particular type. GetHashCode()()()() is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from Object.) |
| GetType()()()() | Gets the Type of the current instance. (Inherited from Object.) |
 | IsConnected | |
| IsMinimumData()()()() |
This can be overridden to allow for different protocols. Ensures the packet has the minimum amount of data in m_TempBuffer before any handling occurs. (Default is BNLS)
|
| LengthStart |
Where the length of the packet is located in the packet (zero based array).
|
| MemberwiseClone()()()() | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnConnected()()()() | |
| OnDataReceived(array<Byte>[]()[][]) | |
| OnDisconnected()()()() | |
| OnException(Exception) | |
| OnProxyConnected()()()() | |
| OnProxyDisconnected(ProxyDisconnectedEventArgs) | |
| OnSocketException(SocketException) | |
| OnSocketInformation(String) | |
| OnSocketInformation(String, array<Object>[]()[][]) | |
| OnTimerElasped()()()() | |
| ProcessConnected()()()() |
Override this method to handle the connected event.
|
| ProcessDataRecieved(array<Byte>[]()[][]) |
Override this method to handle data.
|
| ProcessDisconnected()()()() |
Override this method to handle the disconnected event.
|
| ProcessProxyConnected()()()() | |
| ProcessProxyDisconnected(ProxyDisconnectedEventArgs) | |
| ProcessTimerElasped()()()() | |
| ProxyConnected |
This event is called when the proxy accepts out request for access.
|
| ProxyDisconnected |
This event is called when a proxy connection fails or denies the request.
|
| Send(array<Byte>[]()[][]) | |
| Socket |
The socket for this socket client instance.
|
| SocketConnected(IAsyncResult) |
Do not override this method unless you have advanced knowledge of sockets.
|
| SocketDataArrival(IAsyncResult) |
Do not override this method unless you have advanced knowledge of sockets.
|
| SocketError |
This event is fired when there is a socket exception.
|
| SocketIdentifer | |
| SocketInformation |
This event is fired when information regarding the socket is available.
|
| SocketProxyConnected(IAsyncResult) | |
| SocketProxyDataArrival(IAsyncResult) | |
| Timer | |
| TimerElasped |
The timer by default will fire every five seconds you can change this.
|
| ToString()()()() | (Inherited from Object.) |
| WaitForData(AsyncCallback) |
Do not override this method unless you have advanced knowledge of sockets.
|
Inheritance Hierarchy| Object | ||
 | SocketClient | |
 | BattleNetClient | |
| BnlsClient | |
| AsgardQueueClient | |
Assembly: Asgard5Library (Module: Asgard5Library)