Alchemy.Handlers.WebSocket.hybi00.ClientHandshake Class Reference

An easy wrapper for the header to access client handshake data. See http://www.whatwg.org/specs/web-socket-protocol/ for more details on the WebSocket Protocol. More...

List of all members.

Public Member Functions
	ClientHandshake ()
	ClientHandshake (ArraySegment< byte > challengeBytes, Header header)
	Initializes a new instance of the ClientHandshake class.
bool	IsValid ()
	Determines whether this instance is valid.
override string	ToString ()
	Returns a System.String that represents this instance.
Public Attributes
string	Host = String.Empty
string	Key1 = String.Empty
string	Key2 = String.Empty
string	Origin = String.Empty
string	ResourcePath = String.Empty
Properties
ArraySegment< byte >	ChallengeBytes [get, set]
HttpCookieCollection	Cookies [get, set]
string	SubProtocol [get, set]
Dictionary< string, string >	AdditionalFields [get, set]

---

Detailed Description

An easy wrapper for the header to access client handshake data. See http://www.whatwg.org/specs/web-socket-protocol/ for more details on the WebSocket Protocol.

Definition at line 13 of file Handshakes.cs.

---

Constructor & Destructor Documentation

Alchemy.Handlers.WebSocket.hybi00.ClientHandshake.ClientHandshake

(

)

Definition at line 34 of file Handshakes.cs.

Alchemy.Handlers.WebSocket.hybi00.ClientHandshake.ClientHandshake	(	ArraySegment< byte >	challengeBytes,
		Header	header
	)

Initializes a new instance of the ClientHandshake class.

Parameters:

challengeBytes	The challenge bytes.
header	The header.

Definition at line 42 of file Handshakes.cs.

---

Member Function Documentation

bool Alchemy.Handlers.WebSocket.hybi00.ClientHandshake.IsValid

(

)

Determines whether this instance is valid.

Returns:

true if this instance is valid; otherwise, false.

Definition at line 65 of file Handshakes.cs.

override string Alchemy.Handlers.WebSocket.hybi00.ClientHandshake.ToString

(

)

Returns a System.String that represents this instance.

Returns:

A System.String that represents this instance.

Definition at line 82 of file Handshakes.cs.

---

Member Data Documentation

string Alchemy.Handlers.WebSocket.hybi00.ClientHandshake.Host = String.Empty

Definition at line 28 of file Handshakes.cs.

string Alchemy.Handlers.WebSocket.hybi00.ClientHandshake.Key1 = String.Empty

Definition at line 29 of file Handshakes.cs.

string Alchemy.Handlers.WebSocket.hybi00.ClientHandshake.Key2 = String.Empty

Definition at line 30 of file Handshakes.cs.

string Alchemy.Handlers.WebSocket.hybi00.ClientHandshake.Origin = String.Empty

Definition at line 31 of file Handshakes.cs.

string Alchemy.Handlers.WebSocket.hybi00.ClientHandshake.ResourcePath = String.Empty

Definition at line 32 of file Handshakes.cs.

---

Property Documentation

Dictionary<string, string> Alchemy.Handlers.WebSocket.hybi00.ClientHandshake.AdditionalFields [get, set]

Definition at line 57 of file Handshakes.cs.

ArraySegment<byte> Alchemy.Handlers.WebSocket.hybi00.ClientHandshake.ChallengeBytes [get, set]

Definition at line 54 of file Handshakes.cs.

HttpCookieCollection Alchemy.Handlers.WebSocket.hybi00.ClientHandshake.Cookies [get, set]

Definition at line 55 of file Handshakes.cs.

string Alchemy.Handlers.WebSocket.hybi00.ClientHandshake.SubProtocol [get, set]

Definition at line 56 of file Handshakes.cs.

---

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

• /Users/jlawson/Projects/Alchemy-Websockets/src/Alchemy/Handlers/WebSocket/hybi00/Handshakes.cs