C# Class DotNetty.Codecs.Http.WebSockets.WebSocketServerHandshakerFactory

Public Methods

Method	Description
NewHandshaker ( IHttpRequest req ) : DotNetty.Codecs.Http.WebSockets.WebSocketServerHandshaker	Instances a new handshaker
SendUnsupportedVersionResponse ( IChannel channel ) : Task	Return that we need cannot not support the web socket version
WebSocketServerHandshakerFactory ( string webSocketUrl, string subprotocols, DotNetty.Codecs.Http.WebSockets.WebSocketDecoderConfig decoderConfig ) : System.Threading.Tasks	Constructor specifying the destination web socket location
WebSocketServerHandshakerFactory ( string webSocketUrl, string subprotocols, bool allowExtensions ) : System.Threading.Tasks	Constructor specifying the destination web socket location
WebSocketServerHandshakerFactory ( string webSocketUrl, string subprotocols, bool allowExtensions, int maxFramePayloadLength ) : System.Threading.Tasks	Constructor specifying the destination web socket location
WebSocketServerHandshakerFactory ( string webSocketUrl, string subprotocols, bool allowExtensions, int maxFramePayloadLength, bool allowMaskMismatch ) : System.Threading.Tasks	Constructor specifying the destination web socket location

Instances a new handshaker

public NewHandshaker ( IHttpRequest req ) : DotNetty.Codecs.Http.WebSockets.WebSocketServerHandshaker
req	IHttpRequest
return	DotNetty.Codecs.Http.WebSockets.WebSocketServerHandshaker

Return that we need cannot not support the web socket version

public static SendUnsupportedVersionResponse ( IChannel channel ) : Task
channel	IChannel
return	Task

Constructor specifying the destination web socket location

public WebSocketServerHandshakerFactory ( string webSocketUrl, string subprotocols, DotNetty.Codecs.Http.WebSockets.WebSocketDecoderConfig decoderConfig ) : System.Threading.Tasks
webSocketUrl	string	URL for web socket communications. e.g "ws://myhost.com/mypath". /// Subsequent web socket frames will be sent to this URL.
subprotocols	string	CSV of supported protocols. Null if sub protocols not supported.
decoderConfig	DotNetty.Codecs.Http.WebSockets.WebSocketDecoderConfig	Frames decoder options.
return	System.Threading.Tasks

Constructor specifying the destination web socket location

public WebSocketServerHandshakerFactory ( string webSocketUrl, string subprotocols, bool allowExtensions ) : System.Threading.Tasks
webSocketUrl	string	URL for web socket communications. e.g "ws://myhost.com/mypath". /// Subsequent web socket frames will be sent to this URL.
subprotocols	string	CSV of supported protocols. Null if sub protocols not supported.
allowExtensions	bool	Allow extensions to be used in the reserved bits of the web socket frame
return	System.Threading.Tasks

Constructor specifying the destination web socket location

public WebSocketServerHandshakerFactory ( string webSocketUrl, string subprotocols, bool allowExtensions, int maxFramePayloadLength ) : System.Threading.Tasks
webSocketUrl	string	URL for web socket communications. e.g "ws://myhost.com/mypath". /// Subsequent web socket frames will be sent to this URL.
subprotocols	string	CSV of supported protocols. Null if sub protocols not supported.
allowExtensions	bool	Allow extensions to be used in the reserved bits of the web socket frame
maxFramePayloadLength	int	Maximum allowable frame payload length. Setting this value to your application's /// requirement may reduce denial of service attacks using long data frames.
return	System.Threading.Tasks

Constructor specifying the destination web socket location

public WebSocketServerHandshakerFactory ( string webSocketUrl, string subprotocols, bool allowExtensions, int maxFramePayloadLength, bool allowMaskMismatch ) : System.Threading.Tasks
webSocketUrl	string	URL for web socket communications. e.g "ws://myhost.com/mypath". /// Subsequent web socket frames will be sent to this URL.
subprotocols	string	CSV of supported protocols. Null if sub protocols not supported.
allowExtensions	bool	Allow extensions to be used in the reserved bits of the web socket frame
maxFramePayloadLength	int	Maximum allowable frame payload length. Setting this value to your application's /// requirement may reduce denial of service attacks using long data frames.
allowMaskMismatch	bool	When set to true, frames which are not masked properly according to the standard will still be /// accepted.
return	System.Threading.Tasks