Provides the functions of the server that receives the WebSocket connection requests.
- T
- The type of the WebSocket service that the server provides. The T must inherit the WebSocketSharp.Server.WebSocketService class.
See Also: Inherited members from WebSocketServerBase.
|
Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts on the specified port. | |
|
Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts on the specified WebSocket URL. | |
|
Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts on the specified port and secure. | |
|
Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts on the specified port and absPath. | |
|
Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts on the specified port, absPath and secure. | |
|
Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts on the specified address, port and absPath. | |
|
Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts on the specified address, port, absPath and secure. |
[read-only] | Address | System.Net.IPAddress . Gets the local IP address on which to listen for incoming connection attempts. (Inherited from WebSocketServerBase.) |
[read-only] | IsSecure | bool . Gets a value indicating whether this server is secure. (Inherited from WebSocketServerBase.) |
[read-only] | IsSelfHost | bool . Gets a value indicating whether this server is self host. (Inherited from WebSocketServerBase.) |
[read-only] | Port | int . Gets the port on which to listen for incoming connection attempts. (Inherited from WebSocketServerBase.) |
|
Sweeped | bool . Gets or sets a value indicating whether the server cleans up the inactive client. |
[read-only] | Uri | Uri . Gets the WebSocket URL on which to listen for incoming connection attempts. |
|
BaseUri | Uri . Gets or sets the WebSocket URL on which to listen for incoming connection attempts. (Inherited from WebSocketServerBase.) |
|
Broadcast
(string)Broadcasts the specified string. |
|
|
Broadping
(string)Pings with the specified string to all clients. |
|
|
Start
()Starts to receive the WebSocket connection requests. (Inherited from WebSocketServerBase.) |
|
override
|
Stop
()Stops receiving the WebSocket connection requests. |
|
|
Stop
()Stops receiving the WebSocket connection requests. (Inherited from WebSocketServerBase.) |
override
|
AcceptWebSocket
(System.Net.Sockets.TcpClient)Accepts the WebSocket connection. |
|
abstract
|
AcceptWebSocket
(System.Net.Sockets.TcpClient)Accepts the WebSocket connection. (Inherited from WebSocketServerBase.) |
|
|
Error
(string)Occurs the WebSocketServerBase.OnError event with the specified message. (Inherited from WebSocketServerBase.) |
|
OnError | Occurs when this server gets an error. (Inherited from WebSocketServerBase.) |
|
WebSocketSharp.Server.IServiceHost.BindWebSocket | Binds the specified WebSocketSharp.WebSocket instance to the WebSocket service. |
Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts on the specified port.
Syntax
public WebSocketServiceHost (int port)Parameters
- port
- An int that contains a port number.
Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts on the specified WebSocket URL.
Syntax
public WebSocketServiceHost (string url)Parameters
- url
- A string that contains a WebSocket URL.
Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts on the specified port and secure.
Syntax
Parameters
Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts on the specified port and absPath.
Syntax
Parameters
Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts on the specified port, absPath and secure.
Syntax
Parameters
Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts on the specified address, port and absPath.
Syntax
Parameters
- address
- An System.Net.IPAddress that contains an IP address.
- port
- An int that contains a port number.
- absPath
- A string that contains an absolute path.
Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts on the specified address, port, absPath and secure.
Syntax
Parameters
- address
- An System.Net.IPAddress that contains an IP address.
- port
- An int that contains a port number.
- absPath
- A string that contains an absolute path.
- secure
- A bool that indicates providing a secure connection or not. (true indicates providing a secure connection.)
Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Accepts the WebSocket connection.
Syntax
protected override void AcceptWebSocket (System.Net.Sockets.TcpClient client)Parameters
- client
- A System.Net.Sockets.TcpClient that contains the TCP connection.
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.
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 with the specified string to all clients.
Syntax
public Dictionary<string, bool> Broadping (string message)Parameters
- message
- A string that contains a message.
Returns
Documentation for this section has not yet been entered.Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Stops receiving the WebSocket connection requests.
Syntax
public override void Stop ()Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
Gets or sets a value indicating whether the server cleans up the inactive client.
Syntax
public bool Sweeped { get; set; }Value
true if the server cleans up the inactive client; 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 WebSocket URL on which to listen for incoming connection attempts.
Syntax
public Uri Uri { get; }Value
A Uri that contains a WebSocket URL.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 instance to the WebSocket service.
Syntax
void WebSocketSharp.Server.IServiceHost.BindWebSocket (WebSocketSharp.WebSocket socket)Parameters
- socket
- A WebSocketSharp.WebSocket to bind.
Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)