Provides the basic functions of the WebSocket service.
See Also: Inherited members from object.
|
Initializes a new instance of the WebSocketSharp.Server.WebSocketService class. |
[read-only] | ID | string . Gets the ID of a WebSocketSharp.Server.WebSocketService instance. |
[read-only] | IsBound | bool . Gets a value indicating whether a WebSocketSharp.Server.WebSocketService instance is bound to a WebSocketSharp.WebSocket. |
[read-only] | QueryString | System.Collections.Specialized.NameValueCollection . Gets the HTTP query string variables used in the WebSocket opening handshake. |
[read-only] | Sessions | SessionManager . Gets the sessions to the WebSocket service. |
|
Bind
(WebSocketSharp.WebSocket, SessionManager)Binds the specified WebSocketSharp.WebSocket and WebSocketSharp.Server.SessionManager to a WebSocketSharp.Server.WebSocketService instance. |
|
|
Broadcast
(byte[])Broadcasts the specified array of byte to all clients of the WebSocket service. |
|
|
Broadcast
(string)Broadcasts the specified string to all clients of the WebSocket service. |
|
|
Broadping
()Pings to all clients of the WebSocket service. |
|
|
Broadping
(string)Pings with the specified string to all clients of the WebSocket service. |
|
|
Ping
()Pings to the client of a WebSocketSharp.Server.WebSocketService instance. |
|
|
Ping
(string)Pings with the specified string to the client of a WebSocketSharp.Server.WebSocketService instance. |
|
|
PingTo
(string)Pings to the client of a WebSocketSharp.Server.WebSocketService instance associated with the specified ID. |
|
|
PingTo
(string, string)Pings with the specified string to the client of a WebSocketSharp.Server.WebSocketService instance associated with the specified ID. |
|
|
Send
(byte[])Sends a binary data to the client of a WebSocketSharp.Server.WebSocketService instance. |
|
|
Send
(string)Sends a text data to the client of a WebSocketSharp.Server.WebSocketService instance. |
|
|
SendTo
(string, byte[])Sends a binary data to the client of a WebSocketSharp.Server.WebSocketService instance associated with the specified ID. |
|
|
SendTo
(string, string)Sends a text data to the client of a WebSocketSharp.Server.WebSocketService instance associated with the specified ID. |
|
|
Start
()Starts a WebSocketSharp.Server.WebSocketService instance. |
|
|
Stop
()Stops a WebSocketSharp.Server.WebSocketService instance. |
|
|
Stop
(ushort, string)Stops a WebSocketSharp.Server.WebSocketService instance with the specified ushort and string. |
|
|
Stop
(WebSocketSharp.CloseStatusCode, string)Stops a WebSocketSharp.Server.WebSocketService instance with the specified WebSocketSharp.CloseStatusCode and string. |
|
OnClose
(WebSocketSharp.CloseEventArgs)Occurs when a inner WebSocketSharp.WebSocket receives a Close frame or the Stop method is called. |
|
|
OnError
(WebSocketSharp.ErrorEventArgs)Occurs when a inner WebSocketSharp.WebSocket gets an error. |
|
|
OnMessage
(WebSocketSharp.MessageEventArgs)Occurs when a inner WebSocketSharp.WebSocket receives a data frame. |
|
|
OnOpen
()Occurs when the WebSocket connection has been established. |
Initializes a new instance of the WebSocketSharp.Server.WebSocketService class.
Syntax
public WebSocketService ()Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Binds the specified WebSocketSharp.WebSocket and WebSocketSharp.Server.SessionManager to a WebSocketSharp.Server.WebSocketService instance.
Syntax
Parameters
- socket
- A WebSocketSharp.WebSocket to bind to the WebSocketService.
- sessions
- A WebSocketSharp.Server.SessionManager to bind to the WebSocketService.
Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Broadcasts the specified array of byte to all clients of the WebSocket service.
Syntax
Parameters
- data
- An array of byte to broadcast.
Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Broadcasts the specified string to all clients of the WebSocket service.
Syntax
Parameters
- data
- A string to broadcast.
Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Pings to all clients of the WebSocket service.
Syntax
public Dictionary<string, bool> Broadping ()Returns
A Dictionary<string, bool> that contains the collection of the ID and value indicating whether the WebSocket service received a Pong in a time.Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Pings with the specified string to all clients of the WebSocket service.
Syntax
public Dictionary<string, bool> Broadping (string message)Parameters
- message
- A string that contains a message.
Returns
A Dictionary<string, bool> that contains the collection of the ID and value indicating whether the WebSocket service received a Pong in a time.Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Gets the ID of a WebSocketSharp.Server.WebSocketService instance.
Syntax
public string ID { get; }Value
A string that contains a ID.Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Gets a value indicating whether a WebSocketSharp.Server.WebSocketService instance is bound to a WebSocketSharp.WebSocket.
Syntax
public bool IsBound { get; }Value
true if the WebSocketService is bound to a WebSocket; otherwise, false.Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Occurs when a inner WebSocketSharp.WebSocket receives a Close frame or the Stop method is called.
Syntax
protected virtual void OnClose (WebSocketSharp.CloseEventArgs e)Parameters
- e
- A WebSocketSharp.CloseEventArgs that contains the event data associated with a WebSocketSharp.WebSocket.OnClose event.
Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Occurs when a inner WebSocketSharp.WebSocket gets an error.
Syntax
protected virtual void OnError (WebSocketSharp.ErrorEventArgs e)Parameters
- e
- An WebSocketSharp.ErrorEventArgs that contains the event data associated with a WebSocketSharp.WebSocket.OnError event.
Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Occurs when a inner WebSocketSharp.WebSocket receives a data frame.
Syntax
protected virtual void OnMessage (WebSocketSharp.MessageEventArgs e)Parameters
- e
- A WebSocketSharp.MessageEventArgs that contains the event data associated with a WebSocketSharp.WebSocket.OnMessage event.
Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Occurs when the WebSocket connection has been established.
Syntax
protected virtual void OnOpen ()Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Pings to the client of a WebSocketSharp.Server.WebSocketService instance.
Syntax
public bool Ping ()Returns
true if the WebSocketService receives a Pong in a time; otherwise, false.Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Pings with the specified string to the client of a WebSocketSharp.Server.WebSocketService instance.
Syntax
Parameters
- message
- A string that contains a message.
Returns
true if the WebSocketService receives a Pong in a time; otherwise, false.Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Pings to the client of a WebSocketSharp.Server.WebSocketService instance associated with the specified ID.
Syntax
Parameters
- id
- A string that contains a ID that represents the destination for the Ping.
Returns
true if the WebSocket service receives a Pong in a time; otherwise, false.Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Pings with the specified string to the client of a WebSocketSharp.Server.WebSocketService instance associated with the specified ID.
Syntax
Parameters
Returns
true if the WebSocketService receives a Pong in a time; otherwise, false.Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Gets the HTTP query string variables used in the WebSocket opening handshake.
Syntax
protected System.Collections.Specialized.NameValueCollection QueryString { get; }Value
A System.Collections.Specialized.NameValueCollection that contains the query string variables.Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Sends a binary data to the client of a WebSocketSharp.Server.WebSocketService instance.
Syntax
Parameters
- data
- An array of byte that contains a binary data to send.
Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Sends a text data to the client of a WebSocketSharp.Server.WebSocketService instance.
Syntax
Parameters
- data
- A string that contains a text data to send.
Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Sends a binary data to the client of a WebSocketSharp.Server.WebSocketService instance associated with the specified ID.
Syntax
Parameters
Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Sends a text data to the client of a WebSocketSharp.Server.WebSocketService instance associated with the specified ID.
Syntax
Parameters
Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Gets the sessions to the WebSocket service.
Syntax
protected SessionManager Sessions { get; }Value
A WebSocketSharp.Server.SessionManager that contains the sessions to the WebSocket service.Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Starts a WebSocketSharp.Server.WebSocketService instance.
Syntax
public void Start ()Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Stops a WebSocketSharp.Server.WebSocketService instance.
Syntax
public void Stop ()Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Stops a WebSocketSharp.Server.WebSocketService instance with the specified ushort and string.
Syntax
Parameters
Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Stops a WebSocketSharp.Server.WebSocketService instance with the specified WebSocketSharp.CloseStatusCode and string.
Syntax
Parameters
- code
- One of the WebSocketSharp.CloseStatusCode values that contains a status code indicating the reason for stop.
- reason
- A string that contains a reason for stop.
Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)