WebSocketClose Class Reference

WebSocket control frame to perform connection closure. More...

#include <WebSocketClose>

Public Member Functions
	WebSocketClose (const WebSocketFrame &frame)
	Interpret frame as a WebSocket close frame.
	operator bool () const
	Tell if this is a WebSocket close frame.
WebSocketStatus	status () const
	Get the WebSocket status code.
String	reason () const
	Get the WebSocket closure reason.

Static Public Member Functions
static WebSocketFrame	createFrame (WebSocketStatus status, const String &reason)
	Create a WebSocket close control frame.
static WebSocketFrame	createFrame (WebSocketStatus status)
	Create a WebSocket close control frame.
static WebSocketFrame	createFrame ()
	Create a WebSocket close control frame.

Detailed Description

WebSocket control frame to perform connection closure.

Constructor & Destructor Documentation

WebSocketClose()

WebSocketClose ( const WebSocketFrame &  frame )

explicit

Interpret frame as a WebSocket close frame.

Member Function Documentation

createFrame() [1/3]

static WebSocketFrame createFrame ( WebSocketStatus  status, const String &  reason  )

static

Create a WebSocket close control frame.

createFrame() [2/3]

static WebSocketFrame createFrame ( WebSocketStatus  status )

static

Create a WebSocket close control frame.

createFrame() [3/3]

static WebSocketFrame createFrame ( )

static

Create a WebSocket close control frame.

operator bool()

operator bool ( ) const

explicit

Tell if this is a WebSocket close frame.

status()

WebSocketStatus status

(

)

const

Get the WebSocket status code.

reason()

String reason

(

)

const

Get the WebSocket closure reason.