Class WebSocketServer

Provides a WebSocket protocol server.
Inheritance
System.Object
WebSocketServer
Namespace: Mars.Common.Socket.Server
Assembly: Mars.Common.dll
Syntax
public class WebSocketServer : object
Remarks
This class can provide multiple WebSocket services.

Constructors

WebSocketServer()

Initializes a new instance of the WebSocketServer class.
Declaration
public WebSocketServer()
Remarks
The new instance listens for incoming handshake requests on and port 80.

WebSocketServer(IPAddress, Int32)

Initializes a new instance of the WebSocketServer class with the specified address and port.
Declaration
public WebSocketServer(IPAddress address, int port)
Parameters
Type Name Description
IPAddress address A that represents the local IP address on which to listen.
System.Int32 port An that represents the number of the port on which to listen.
Remarks

The new instance listens for incoming handshake requests on address and port.

It provides secure connections if port is 443.

WebSocketServer(IPAddress, Int32, Boolean)

Initializes a new instance of the WebSocketServer class with the specified address, port, and secure.
Declaration
public WebSocketServer(IPAddress address, int port, bool secure)
Parameters
Type Name Description
IPAddress address A that represents the local IP address on which to listen.
System.Int32 port An that represents the number of the port on which to listen.
System.Boolean secure A : true if the new instance provides secure connections; otherwise, false.
Remarks
The new instance listens for incoming handshake requests on address and port.

WebSocketServer(Int32)

Initializes a new instance of the WebSocketServer class with the specified port.
Declaration
public WebSocketServer(int port)
Parameters
Type Name Description
System.Int32 port An that represents the number of the port on which to listen.
Remarks

The new instance listens for incoming handshake requests on and port.

It provides secure connections if port is 443.

WebSocketServer(Int32, Boolean)

Initializes a new instance of the WebSocketServer class with the specified port and secure.
Declaration
public WebSocketServer(int port, bool secure)
Parameters
Type Name Description
System.Int32 port An that represents the number of the port on which to listen.
System.Boolean secure A : true if the new instance provides secure connections; otherwise, false.
Remarks
The new instance listens for incoming handshake requests on and port.

WebSocketServer(String)

Initializes a new instance of the WebSocketServer class with the specified url.
Declaration
public WebSocketServer(string url)
Parameters
Type Name Description
System.String url A that represents the WebSocket URL of the server.
Remarks

The new instance listens for incoming handshake requests on the IP address of the host of url and the port of url.

Either port 80 or 443 is used if url includes no port. Port 443 is used if the scheme of url is wss; otherwise, port 80 is used.

The new instance provides secure connections if the scheme of url is wss.

Properties

Address

Gets the IP address of the server.
Declaration
public IPAddress Address { get; }
Property Value
Type Description
IPAddress A that represents the local IP address on which to listen for incoming handshake requests.

AllowForwardedRequest

Gets or sets a value indicating whether the server accepts every handshake request without checking the request URI.
Declaration
public bool AllowForwardedRequest { get; set; }
Property Value
Type Description
System.Boolean

true if the server accepts every handshake request without checking the request URI; otherwise, false.

The default value is false.

Remarks
The set operation does nothing if the server has already started or it is shutting down.

IsListening

Gets a value indicating whether the server has started.
Declaration
public bool IsListening { get; }
Property Value
Type Description
System.Boolean true if the server has started; otherwise, false.

KeepClean

Gets or sets a value indicating whether the server cleans up the inactive sessions periodically.
Declaration
public bool KeepClean { get; set; }
Property Value
Type Description
System.Boolean

true if the server cleans up the inactive sessions every 60 seconds; otherwise, false.

The default value is true.

Remarks
The set operation does nothing if the server has already started or it is shutting down.

Port

Gets the port of the server.
Declaration
public int Port { get; }
Property Value
Type Description
System.Int32 An that represents the number of the port on which to listen for incoming handshake requests.

ReuseAddress

Gets or sets a value indicating whether the server is allowed to be bound to an address that is already in use.
Declaration
public bool ReuseAddress { get; set; }
Property Value
Type Description
System.Boolean

true if the server is allowed to be bound to an address that is already in use; otherwise, false.

The default value is false.

Remarks

You should set this property to true if you would like to resolve to wait for socket in TIME_WAIT state.

The set operation does nothing if the server has already started or it is shutting down.

WaitTime

Gets or sets the time to wait for the response to the WebSocket Ping or Close.
Declaration
public TimeSpan WaitTime { get; set; }
Property Value
Type Description
TimeSpan

A to wait for the response.

The default value is the same as 1 second.

Remarks
The set operation does nothing if the server has already started or it is shutting down.

WebSocketServices

Gets the management function for the WebSocket services provided by the server.
Declaration
public WebSocketServiceManager WebSocketServices { get; }
Property Value
Type Description
WebSocketServiceManager A WebSocketServiceManager that manages the WebSocket services provided by the server.

Methods

AddWebSocketService<TBehaviorWithNew>(String)

Adds a WebSocket service with the specified behavior and path.
Declaration
public void AddWebSocketService<TBehaviorWithNew>(string path)
    where TBehaviorWithNew : WebSocketBehavior, new()
Parameters
Type Name Description
System.String path A that represents an absolute path to the service to add.
Type Parameters
Name Description
TBehaviorWithNew

The type of the behavior for the service.

It must inherit the WebSocketBehavior class and have a public parameterless constructor.

Remarks
path is converted to a URL-decoded string and '/' is trimmed from the end of the converted string if any.

AddWebSocketService<TBehaviorWithNew>(String, Action<TBehaviorWithNew>)

Adds a WebSocket service with the specified behavior, path, and initializer.
Declaration
public void AddWebSocketService<TBehaviorWithNew>(string path, Action<TBehaviorWithNew> initializer)
    where TBehaviorWithNew : WebSocketBehavior, new()
Parameters
Type Name Description
System.String path A that represents an absolute path to the service to add.
Action<TBehaviorWithNew> initializer

An Action<TBehaviorWithNew> delegate or langword_csharp_null if not needed.

That delegate invokes the method called for initializing a new session instance for the service.

Type Parameters
Name Description
TBehaviorWithNew

The type of the behavior for the service.

It must inherit the WebSocketBehavior class and have a public parameterless constructor.

Remarks
path is converted to a URL-decoded string and '/' is trimmed from the end of the converted string if any.

AddWebSocketService<TBehavior>(String, Func<TBehavior>)

Adds a WebSocket service with the specified behavior, path, and creator.
Declaration
public void AddWebSocketService<TBehavior>(string path, Func<TBehavior> creator)
    where TBehavior : WebSocketBehavior
Parameters
Type Name Description
System.String path A that represents an absolute path to the service to add.
Func<TBehavior> creator

A Func<TBehavior> delegate.

It invokes the method called for creating a new session instance for the service.

The method must create a new instance of the specified behavior class and return it.

Type Parameters
Name Description
TBehavior

The type of the behavior for the service.

It must inherit the WebSocketBehavior class.

Remarks
path is converted to a URL-decoded string and '/' is trimmed from the end of the converted string if any.

RemoveWebSocketService(String)

Removes a WebSocket service with the specified path.
Declaration
public bool RemoveWebSocketService(string path)
Parameters
Type Name Description
System.String path A that represents an absolute path to the service to remove.
Returns
Type Description
System.Boolean true if the service is successfully found and removed; otherwise, false.
Remarks

path is converted to a URL-decoded string and '/' is trimmed from the end of the converted string if any.

The service is stopped with close status 1001 (going away) if it has already started.

Start()

Starts receiving incoming handshake requests.
Declaration
public void Start()
Remarks
This method does nothing if the server has already started or it is shutting down.

Stop()

Stops receiving incoming handshake requests and closes each connection.
Declaration
public void Stop()
Remarks
This method does nothing if the server is not started, it is shutting down, or it has already stopped.

Stop(CloseStatusCode, String)

Stops receiving incoming handshake requests and closes each connection with the specified code and reason.
Declaration
public void Stop(CloseStatusCode code, string reason)
Parameters
Type Name Description
CloseStatusCode code

One of the CloseStatusCode enum values.

It represents the status code indicating the reason for the close.

System.String reason

A that represents the reason for the close.

The size must be 123 bytes or less in UTF-8.

Remarks
This method does nothing if the server is not started, it is shutting down, or it has already stopped.

Stop(UInt16, String)

Stops receiving incoming handshake requests and closes each connection with the specified code and reason.
Declaration
public void Stop(ushort code, string reason)
Parameters
Type Name Description
System.UInt16 code

A that represents the status code indicating the reason for the close.

The status codes are defined in Section 7.4 of RFC 6455.

System.String reason

A that represents the reason for the close.

The size must be 123 bytes or less in UTF-8.

Remarks
This method does nothing if the server is not started, it is shutting down, or it has already stopped.

Extension Methods