WebSocket Class Reference

#include <WebSocket.h>

Classes
struct	Data
	Data structure for message. More...
class	Delegate
	The delegate class is used to process websocket events. More...

Public Types
enum	ErrorCode { TIME_OUT, CONNECTION_FAILURE, UNKNOWN }
	ErrorCode enum used to represent the error in the websocket. More...
enum	State { CONNECTING, OPEN, CLOSING, CLOSED }
	State enum used to represent the Websocket state. More...

Public Member Functions
	WebSocket ()
	Construtor of WebSocket. More...
	ctor ()
	Construtor of WebSocket. More...
	WebSocket ()
	Construtor of WebSocket. More...
virtual	~WebSocket ()
	Destructor of WebSocket. More...
bool	init (const Delegate &delegate, const std::string &url, const std::vector< std::string > *protocols=nullptr)
	The initialized method for websocket. More...
void	send (const std::string &message)
	Sends string data to websocket server. More...
void	send (const unsigned char *binaryMsg, unsigned int len)
	Sends binary data to websocket server. More...
var	send ( var binaryMsg, var len)
	Sends binary data to websocket server. More...
local	sendstring ( local binaryMsg, local len)
	Sends binary data to websocket server. More...
void	close ()
	Closes the connection to server. More...
State	getReadyState ()
	Gets current state of connection. More...

Friends
class	WebSocketCallbackWrapper
class	WsThreadHelper

Member Enumeration Documentation

enum ErrorCode

strong

ErrorCode enum used to represent the error in the websocket.

Enumerator
TIME_OUT
CONNECTION_FAILURE	< value 0
UNKNOWN	< value 1

var ErrorCode

strong

ErrorCode enum used to represent the error in the websocket.

Enumerator
TIME_OUT
CONNECTION_FAILURE	< value 0
UNKNOWN	< value 1

local ErrorCode

strong

ErrorCode enum used to represent the error in the websocket.

Enumerator
TIME_OUT
CONNECTION_FAILURE	< value 0
UNKNOWN	< value 1

enum State

strong

State enum used to represent the Websocket state.

Enumerator
CONNECTING
OPEN	< value 0
CLOSING	< value 1
CLOSED	< value 2

var State

strong

State enum used to represent the Websocket state.

Enumerator
CONNECTING
OPEN	< value 0
CLOSING	< value 1
CLOSED	< value 2

local State

strong

State enum used to represent the Websocket state.

Enumerator
CONNECTING
OPEN	< value 0
CLOSING	< value 1
CLOSED	< value 2

Constructor & Destructor Documentation

WebSocket

(

)

Construtor of WebSocket.

var ctor

(

)

Construtor of WebSocket.

local WebSocket

(

)

Construtor of WebSocket.

virtual ~WebSocket ( )

virtual

Destructor of WebSocket.

Member Function Documentation

void close

(

)

Closes the connection to server.

var close

(

)

Closes the connection to server.

local close

(

)

Closes the connection to server.

State getReadyState

(

)

Gets current state of connection.

Returns

State the state value coule be State::CONNECTING, State::OPEN, State::CLOSING or State::CLOSED

var getReadyState

(

)

Gets current state of connection.

Returns

State the state value coule be State::CONNECTING, State::OPEN, State::CLOSING or State::CLOSED

local getReadyState

(

)

Gets current state of connection.

Returns

State the state value coule be State::CONNECTING, State::OPEN, State::CLOSING or State::CLOSED

bool init	(	const Delegate &	delegate,
		const std::string &	url,
		const std::vector< std::string > *	protocols = nullptr
	)

The initialized method for websocket.

It needs to be invoked right after websocket instance is allocated.

Parameters

delegate	The delegate which want to receive event from websocket.
url	The URL of websocket server.

Returns

true: Success, false: Failure.

var init	(	var	delegate,
		var	url,
		var	protocols = nullptr
	)

The initialized method for websocket.

It needs to be invoked right after websocket instance is allocated.

Parameters

delegate	The delegate which want to receive event from websocket.
url	The URL of websocket server.

Returns

true: Success, false: Failure.

void send

(

const std::string &

message

)

Sends string data to websocket server.

Parameters

message

string data.

var send

(

var

message

)

Sends string data to websocket server.

Parameters

message

string data.

local sendstring

(

local

message

)

Sends string data to websocket server.

Parameters

message

string data.

void send	(	const unsigned char *	binaryMsg,
		unsigned int	len
	)

Sends binary data to websocket server.

Parameters

binaryMsg	binary string data.
len	the size of binary string data.

var send	(	var	binaryMsg,
		var	len
	)

Sends binary data to websocket server.

Parameters

binaryMsg	binary string data.
len	the size of binary string data.

local sendstring	(	local	binaryMsg,
		local	len
	)

Sends binary data to websocket server.

Parameters

binaryMsg	binary string data.
len	the size of binary string data.

Friends And Related Function Documentation

friend class WebSocketCallbackWrapper

friend

friend class WsThreadHelper

friend

var WsThreadHelper

friend

local WsThreadHelper

friend

---

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

• /Users/minggo/SourceCode/cocos2d-x/cocos/network/WebSocket.h