Singleton class used to connect to a server More...
Inheritance diagram for SmartEngine.Networking.Client:
Classes | |
| class | ConnectEvent |
| class | DisconnectEvent |
| class | MessageEvent |
Public Member Functions | |
| bool | Connect (string ipPort) |
| Connect to a server More... | |
| bool | Connect (string ip, ushort port) |
| Connects to a server More... | |
| void | Disconnect () |
| Disconnect from the server More... | |
| void | SendMessage (Message message) |
| Sends a message to the server. The message is sent asynchronously More... | |
| async Task | SendMessageAsync (Message message) |
| Awaitable version of SendMessage More... | |
Public Attributes | |
| ConnectEvent | OnConnected |
| Invoked when we connect to a server More... | |
| DisconnectEvent | OnDisconnected |
| Invoked when disconnected from the server More... | |
| MessageEvent | OnMessage |
| Invoked when a message is received More... | |
Properties | |
| bool | IsConnected [get] |
| Returns true if connected More... | |
 Properties inherited from SmartEngine.SingletonBehavior< Client > | |
| static T | Instance [get] |
Detailed Description
Singleton class used to connect to a server
Member Function Documentation
◆ Connect() [1/2]
| bool SmartEngine.Networking.Client.Connect | ( | string | ip, |
| ushort | port | ||
| ) |
Connects to a server
- Parameters
-
ip port
- Returns
◆ Connect() [2/2]
| bool SmartEngine.Networking.Client.Connect | ( | string | ipPort | ) |
Connect to a server
- Parameters
-
ipPort In the format "[server]:[port]"
- Returns
◆ Disconnect()
| void SmartEngine.Networking.Client.Disconnect | ( | ) |
Disconnect from the server
◆ SendMessage()
| void SmartEngine.Networking.Client.SendMessage | ( | Message | message | ) |
Sends a message to the server. The message is sent asynchronously
- Parameters
-
message
◆ SendMessageAsync()
| async Task SmartEngine.Networking.Client.SendMessageAsync | ( | Message | message | ) |
Awaitable version of SendMessage
- Parameters
-
message
- Returns
Member Data Documentation
◆ OnConnected
| ConnectEvent SmartEngine.Networking.Client.OnConnected |
Invoked when we connect to a server
◆ OnDisconnected
| DisconnectEvent SmartEngine.Networking.Client.OnDisconnected |
Invoked when disconnected from the server
◆ OnMessage
| MessageEvent SmartEngine.Networking.Client.OnMessage |
Invoked when a message is received
Property Documentation
◆ IsConnected
|
get |
Returns true if connected
