WebSocketSessionManager Class |
Provides the management function for the sessions in a WebSocket service.
Inheritance HierarchySystemObject
Sfs2X.WebSocketSharp.ServerWebSocketSessionManager
Sfs2X.WebSocketSharp.ServerWebSocketSessionManager
Namespace: Sfs2X.WebSocketSharp.Server
Assembly: SmartFox2X (in SmartFox2X.dll) Version: 1.8.0.0 (1.8.0)
SyntaxC#
public class WebSocketSessionManager
The WebSocketSessionManager type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ActiveIDs |
Gets the IDs for the active sessions in the WebSocket service.
|
| Count |
Gets the number of the sessions in the WebSocket service.
|
| IDs |
Gets the IDs for the sessions in the WebSocket service.
|
| InactiveIDs |
Gets the IDs for the inactive sessions in the WebSocket service.
|
| Item |
Gets the session instance with id.
|
| KeepClean |
Gets or sets a value indicating whether the inactive sessions in
the WebSocket service are cleaned up periodically.
|
| Sessions |
Gets the session instances in the WebSocket service.
|
| WaitTime |
Gets or sets the time to wait for the response to the WebSocket Ping or
Close.
|
Methods| Name | Description | |
|---|---|---|
 | Broadcast(Byte) |
Sends data to every client in the WebSocket service.
|
| Broadcast(String) |
Sends data to every client in the WebSocket service.
|
| Broadcast(Stream, Int32) |
Sends the data from stream to every client in
the WebSocket service.
|
| BroadcastAsync(Byte, Action) |
Sends data asynchronously to every client in
the WebSocket service.
|
| BroadcastAsync(String, Action) |
Sends data asynchronously to every client in
the WebSocket service.
|
| BroadcastAsync(Stream, Int32, Action) |
Sends the data from stream asynchronously to
every client in the WebSocket service.
|
| Broadping | Obsolete.
Sends a ping to every client in the WebSocket service.
|
| Broadping(String) | Obsolete.
Sends a ping with message to every client in
the WebSocket service.
|
| CloseSession(String) |
Closes the specified session.
|
| CloseSession(String, CloseStatusCode, String) |
Closes the specified session with code and
reason.
|
| CloseSession(String, UInt16, String) |
Closes the specified session with code and
reason.
|
| PingTo(String) |
Sends a ping to the client using the specified session.
|
| PingTo(String, String) |
Sends a ping with message to the client using
the specified session.
|
| SendTo(Byte, String) |
Sends data to the client using the specified session.
|
| SendTo(String, String) |
Sends data to the client using the specified session.
|
| SendTo(Stream, Int32, String) |
Sends the data from stream to the client using
the specified session.
|
| SendToAsync(Byte, String, ActionBoolean) |
Sends data asynchronously to the client using
the specified session.
|
| SendToAsync(String, String, ActionBoolean) |
Sends data asynchronously to the client using
the specified session.
|
| SendToAsync(Stream, Int32, String, ActionBoolean) |
Sends the data from stream asynchronously to
the client using the specified session.
|
| Sweep |
Cleans up the inactive sessions in the WebSocket service.
|
| TryGetSession |
Tries to get the session instance with id.
|
Remarks
This class manages the sessions in a WebSocket service provided by
the WebSocketServer or HttpServer.
See Also