Nakama .NET Client SDK 3.8.0
Nakama .NET Client SDK
Loading...
Searching...
No Matches
Nakama.Ninja.WebSockets.WebSocketHttpContext Class Reference

The WebSocket HTTP Context used to initiate a WebSocket handshake. More...

Public Member Functions

 WebSocketHttpContext (bool isWebSocketRequest, IList< string > webSocketRequestedProtocols, string httpHeader, string path, System.IO.Stream stream)
 Initialises a new instance of the WebSocketHttpContext class.
 

Properties

bool IsWebSocketRequest [get]
 True if this is a valid WebSocket request.
 
IList< string > WebSocketRequestedProtocols [get]
 
string HttpHeader [get]
 The raw http header extracted from the stream.
 
string Path [get]
 The Path extracted from the http header.
 
System.IO.Stream Stream [get]
 The stream AFTER the header has already been read.
 

Detailed Description

The WebSocket HTTP Context used to initiate a WebSocket handshake.

Constructor & Destructor Documentation

◆ WebSocketHttpContext()

Nakama.Ninja.WebSockets.WebSocketHttpContext.WebSocketHttpContext ( bool  isWebSocketRequest,
IList< string >  webSocketRequestedProtocols,
string  httpHeader,
string  path,
System::IO::Stream  stream 
)
inline

Initialises a new instance of the WebSocketHttpContext class.

Parameters
isWebSocketRequestTrue if this is a valid WebSocket request
httpHeaderThe raw http header extracted from the stream
pathThe Path extracted from the http header
streamThe stream AFTER the header has already been read

Property Documentation

◆ HttpHeader

string Nakama.Ninja.WebSockets.WebSocketHttpContext.HttpHeader
get

The raw http header extracted from the stream.

◆ IsWebSocketRequest

bool Nakama.Ninja.WebSockets.WebSocketHttpContext.IsWebSocketRequest
get

True if this is a valid WebSocket request.

◆ Path

string Nakama.Ninja.WebSockets.WebSocketHttpContext.Path
get

The Path extracted from the http header.

◆ Stream

System.IO.Stream Nakama.Ninja.WebSockets.WebSocketHttpContext.Stream
get

The stream AFTER the header has already been read.

◆ WebSocketRequestedProtocols

IList<string> Nakama.Ninja.WebSockets.WebSocketHttpContext.WebSocketRequestedProtocols
get

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