WebSocketServerStop Method (CloseStatusCode, String)

Note: This API is now obsolete.

Stops receiving incoming handshake requests and closes each connection with the specified code and reason.

Namespace: Sfs2X.WebSocketSharp.Server
Assembly: SmartFox2X (in SmartFox2X.dll) Version: 1.8.0.0 (1.8.0)

Syntax

[ObsoleteAttribute("This method will be removed.")]
public void Stop(
	CloseStatusCode code,
	string reason
)

code

Type: Sfs2X.WebSocketSharpCloseStatusCode

One of the CloseStatusCode enum values.

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

reason

Type: SystemString

A String that represents the reason for the close.

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

Exceptions

Exception	Condition
ArgumentException	code is MandatoryExtension. -or- code is NoStatus and there is reason. -or- reason could not be UTF-8-encoded.
ArgumentOutOfRangeException	The size of reason is greater than 123 bytes.
InvalidOperationException	The underlying TcpListener has failed to stop.

Exception

Condition

ArgumentException

-or-

code is NoStatus and there is reason.

-or-

reason could not be UTF-8-encoded.

ArgumentOutOfRangeException

The size of reason is greater than 123 bytes.

InvalidOperationException

The underlying TcpListener has failed to stop.