Provides a WebSocket protocol server. More...

Public Member Functions
	WebSocketServer ()
	Initializes a new instance of the WebSocketServer class.

	WebSocketServer (int port)
	Initializes a new instance of the WebSocketServer class with the specified port.

	WebSocketServer (string url)
	Initializes a new instance of the WebSocketServer class with the specified URL.

	WebSocketServer (int port, bool secure)
	Initializes a new instance of the WebSocketServer class with the specified port and boolean if secure or not.

	WebSocketServer (System.Net.IPAddress address, int port)
	Initializes a new instance of the WebSocketServer class with the specified IP address and port.

	WebSocketServer (System.Net.IPAddress address, int port, bool secure)
	Initializes a new instance of the WebSocketServer class with the specified IP address, port, and boolean if secure or not.

void	AddWebSocketService< TBehavior > (string path)
	Adds a WebSocket service with the specified behavior and path.

void	AddWebSocketService< TBehavior > (string path, Action< TBehavior > initializer)
	Adds a WebSocket service with the specified behavior, path, and delegate.

bool	RemoveWebSocketService (string path)
	Removes a WebSocket service with the specified path.

void	Start ()
	Starts receiving incoming handshake requests.

void	Stop ()
	Stops receiving incoming handshake requests.

Properties
System.Net.IPAddress	Address `[get]`
	Gets the IP address of the server.

bool	AllowForwardedRequest `[get, set]`
	Gets or sets a value indicating whether the server accepts every handshake request without checking the request URI.

AuthenticationSchemes	AuthenticationSchemes `[get, set]`
	Gets or sets the scheme used to authenticate the clients.

bool	IsListening `[get]`
	Gets a value indicating whether the server has started.

bool	IsSecure `[get]`
	Gets a value indicating whether secure connections are provided.

bool	KeepClean `[get, set]`
	Gets or sets a value indicating whether the server cleans up the inactive sessions periodically.

Logger	Log `[get]`
	Gets the logging function for the server.

int	Port `[get]`
	Gets the port of the server.

string	Realm `[get, set]`
	Gets or sets the name of the realm associated with the server.

bool	ReuseAddress `[get, set]`
	Gets or sets a value indicating whether the server is allowed to be bound to an address that is already in use.

ServerSslConfiguration	SslConfiguration `[get]`
	Gets the configuration for secure connection.

Func< IIdentity, NetworkCredential >	UserCredentialsFinder `[get, set]`
	Gets or sets the delegate used to find the credentials for an identity.

TimeSpan	WaitTime `[get, set]`
	Gets or sets the time to wait for the response to the WebSocket Ping or Close.

WebSocketServiceManager	WebSocketServices `[get]`
	Gets the management function for the WebSocket services provided by the server.

Detailed Description

Provides a WebSocket protocol server.

This class can provide multiple WebSocket services.

Constructor & Destructor Documentation

◆ WebSocketServer() [1/6]

WebSocketSharp.Server.WebSocketServer.WebSocketServer ( )

inline

Initializes a new instance of the WebSocketServer class.

The new instance listens for incoming handshake requests on System.Net.IPAddress.Any and port 80.

◆ WebSocketServer() [2/6]

WebSocketSharp.Server.WebSocketServer.WebSocketServer ( int port )

inline

Initializes a new instance of the WebSocketServer class with the specified port.

The new instance listens for incoming handshake requests on System.Net.IPAddress.Any and port .

It provides secure connections if port is 443.

Parameters

port	An int that specifies the number of the port on which to listen.

Exceptions

ArgumentOutOfRangeException port is less than 1 or greater than 65535.

◆ WebSocketServer() [3/6]

WebSocketSharp.Server.WebSocketServer.WebSocketServer ( string url )

inline

Initializes a new instance of the WebSocketServer class with the specified URL.

The new instance listens for incoming handshake requests on the IP address and 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.

Parameters

url	A string that specifies the WebSocket URL of the server.

Exceptions

ArgumentNullException	url is `null`.
ArgumentException	url is an empty string. -or- url is invalid.

◆ WebSocketServer() [4/6]

WebSocketSharp.Server.WebSocketServer.WebSocketServer	(	int	port,
		bool	secure
	)

inline

Initializes a new instance of the WebSocketServer class with the specified port and boolean if secure or not.

The new instance listens for incoming handshake requests on System.Net.IPAddress.Any and port .

Parameters

port	An int that specifies the number of the port on which to listen.
secure	A bool: `true` if the new instance provides secure connections; otherwise, `false`.

Exceptions

ArgumentOutOfRangeException port is less than 1 or greater than 65535.

◆ WebSocketServer() [5/6]

WebSocketSharp.Server.WebSocketServer.WebSocketServer	(	System::Net::IPAddress	address,
		int	port
	)

inline

Initializes a new instance of the WebSocketServer class with the specified IP address and port.

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

It provides secure connections if port is 443.

Parameters

address	A System.Net.IPAddress that specifies the local IP address on which to listen.
port	An int that specifies the number of the port on which to listen.

Exceptions

ArgumentNullException	address is `null`.
ArgumentException	address is not a local IP address.
ArgumentOutOfRangeException	port is less than 1 or greater than 65535.

◆ WebSocketServer() [6/6]

WebSocketSharp.Server.WebSocketServer.WebSocketServer	(	System::Net::IPAddress	address,
		int	port,
		bool	secure
	)

inline

Initializes a new instance of the WebSocketServer class with the specified IP address, port, and boolean if secure or not.

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

Parameters

address	A System.Net.IPAddress that specifies the local IP address on which to listen.
port	An int that specifies the number of the port on which to listen.
secure	A bool: `true` if the new instance provides secure connections; otherwise, `false`.

Exceptions

ArgumentNullException	address is `null`.
ArgumentException	address is not a local IP address.
ArgumentOutOfRangeException	port is less than 1 or greater than 65535.

Member Function Documentation

◆ AddWebSocketService< TBehavior >() [1/2]

void WebSocketSharp.Server.WebSocketServer.AddWebSocketService< TBehavior > ( string path )

inline

Adds a WebSocket service with the specified behavior and path.

Parameters

path	A string that specifies an absolute path to the service to add. / is trimmed from the end of the string if present.

Template Parameters

TBehavior The type of the behavior for the service. It must inherit the WebSocketBehavior class. And also, it must have a public parameterless constructor.

Exceptions

ArgumentNullException	path is `null`.
ArgumentException	path is an empty string. -or- path is not an absolute path. -or- path includes either or both query and fragment components. -or- path is already in use.

Type Constraints

TBehavior	:	WebSocketBehavior
TBehavior	:	new

◆ AddWebSocketService< TBehavior >() [2/2]

void WebSocketSharp.Server.WebSocketServer.AddWebSocketService< TBehavior >	(	string	path,
		Action< TBehavior >	initializer
	)

inline

Adds a WebSocket service with the specified behavior, path, and delegate.

Parameters

path	A string that specifies an absolute path to the service to add. / is trimmed from the end of the string if present.
initializer	An `Action<TBehavior>` delegate or `null` if not needed. The delegate invokes the method called when initializing a new session instance for the service.

Template Parameters

TBehavior The type of the behavior for the service. It must inherit the WebSocketBehavior class. And also, it must have a public parameterless constructor.

Exceptions

ArgumentNullException	path is `null`.
ArgumentException	path is an empty string. -or- path is not an absolute path. -or- path includes either or both query and fragment components. -or- path is already in use.

Type Constraints

TBehavior	:	WebSocketBehavior
TBehavior	:	new

◆ RemoveWebSocketService()

bool WebSocketSharp.Server.WebSocketServer.RemoveWebSocketService ( string path )

inline

Removes a WebSocket service with the specified path.

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

Returns: true if the service is successfully found and removed; otherwise, false.

Parameters

path	A string that specifies an absolute path to the service to remove. / is trimmed from the end of the string if present.

Exceptions

ArgumentNullException	path is `null`.
ArgumentException	path is an empty string. -or- path is not an absolute path. -or- path includes either or both query and fragment components.

◆ Start()

void WebSocketSharp.Server.WebSocketServer.Start ( )

inline

Starts receiving incoming handshake requests.

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

Exceptions

InvalidOperationException There is no server certificate for secure connection. -or- The underlying TcpListener has failed to start.

◆ Stop()

void WebSocketSharp.Server.WebSocketServer.Stop ( )

inline

Stops receiving incoming handshake requests.

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

Property Documentation

◆ Address

System.Net.IPAddress WebSocketSharp.Server.WebSocketServer.Address

get

Gets the IP address of the server.

A System.Net.IPAddress that represents the local IP address on which to listen for incoming handshake requests.

◆ AllowForwardedRequest

bool WebSocketSharp.Server.WebSocketServer.AllowForwardedRequest

getset

Gets or sets a value indicating whether the server accepts every handshake request without checking the request URI.

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

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

The default value is false.

◆ AuthenticationSchemes

AuthenticationSchemes WebSocketSharp.Server.WebSocketServer.AuthenticationSchemes

getset

Gets or sets the scheme used to authenticate the clients.

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

One of the WebSocketSharp.Net.AuthenticationSchemes enum values.

It represents the scheme used to authenticate the clients.

The default value is WebSocketSharp.Net.AuthenticationSchemes.Anonymous.

◆ IsListening

bool WebSocketSharp.Server.WebSocketServer.IsListening

get

Gets a value indicating whether the server has started.

true if the server has started; otherwise, false.

◆ IsSecure

bool WebSocketSharp.Server.WebSocketServer.IsSecure

get

Gets a value indicating whether secure connections are provided.

true if the server provides secure connections; otherwise, false.

◆ KeepClean

bool WebSocketSharp.Server.WebSocketServer.KeepClean

getset

Gets or sets a value indicating whether the server cleans up the inactive sessions periodically.

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

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

The default value is true.

◆ Log

Logger WebSocketSharp.Server.WebSocketServer.Log

get

Gets the logging function for the server.

The default logging level is LogLevel.Error.

A Logger that provides the logging function.

◆ Port

int WebSocketSharp.Server.WebSocketServer.Port

get

Gets the port of the server.

An int that represents the number of the port on which to listen for incoming handshake requests.

◆ Realm

string WebSocketSharp.Server.WebSocketServer.Realm

getset

Gets or sets the name of the realm associated with the server.

"SECRET AREA" is used as the name of the realm if the value is null or an empty string.

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

A string that represents the name of the realm or null.

The default value is null.

◆ ReuseAddress

bool WebSocketSharp.Server.WebSocketServer.ReuseAddress

getset

Gets or sets a value indicating whether the server is allowed to be bound to an address that is already in use.

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.

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

The default value is false.

◆ SslConfiguration

ServerSslConfiguration WebSocketSharp.Server.WebSocketServer.SslConfiguration

get

Gets the configuration for secure connection.

The configuration will be referenced when attempts to start, so it must be configured before the start method is called.

A ServerSslConfiguration that represents the configuration used to provide secure connections.

Exceptions

InvalidOperationException The server does not provide secure connections.

◆ UserCredentialsFinder

Func<IIdentity, NetworkCredential> WebSocketSharp.Server.WebSocketServer.UserCredentialsFinder

getset

Gets or sets the delegate used to find the credentials for an identity.

No credentials are found if the method invoked by the delegate returns null or the value is null.

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

A Func<IIdentity, NetworkCredential> delegate or null if not needed.

The delegate invokes the method called for finding the credentials used to authenticate a client.

The default value is null.

◆ WaitTime

TimeSpan WebSocketSharp.Server.WebSocketServer.WaitTime

getset

Gets or sets the time to wait for the response to the WebSocket Ping or Close.

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

A TimeSpan to wait for the response.

The default value is the same as 1 second.

Exceptions

ArgumentOutOfRangeException The value specified for a set operation is zero or less.

◆ WebSocketServices

WebSocketServiceManager WebSocketSharp.Server.WebSocketServer.WebSocketServices

get

Gets the management function for the WebSocket services provided by the server.

A WebSocketServiceManager that manages the WebSocket services provided by the server.

The documentation for this class was generated from the following file:

C:/Transhuman/S2/Assets/Plugins/Teal-Net/Plugins/websocket-sharp/Server/WebSocketServer.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ WebSocketServer() [1/6]

◆ WebSocketServer() [2/6]

◆ WebSocketServer() [3/6]

◆ WebSocketServer() [4/6]

◆ WebSocketServer() [5/6]

◆ WebSocketServer() [6/6]

Member Function Documentation

◆ AddWebSocketService< TBehavior >() [1/2]

◆ AddWebSocketService< TBehavior >() [2/2]

◆ RemoveWebSocketService()

◆ Start()

◆ Stop()

Property Documentation

◆ Address

◆ AllowForwardedRequest

◆ AuthenticationSchemes

◆ IsListening

◆ IsSecure

◆ KeepClean

◆ Log

◆ Port

◆ Realm

◆ ReuseAddress

◆ SslConfiguration

◆ UserCredentialsFinder

◆ WaitTime

◆ WebSocketServices