WebSocket is wrapper of the libwebsockets-protocol, let the develop could call the websocket easily.
More...
|
| WebSocket () |
| Constructor 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, const std::string &caFilePath="") |
| 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...
|
|
void | close () |
| Closes the connection to server synchronously. More...
|
|
void | closeAsync () |
| Closes the connection to server asynchronously. More...
|
|
State | getReadyState () |
| Gets current state of connection. More...
|
|
const std::string & | getUrl () const |
| Gets the URL of websocket connection.
|
|
const std::string & | getProtocol () const |
| Gets the protocol selected by websocket server.
|
|
WebSocket is wrapper of the libwebsockets-protocol, let the develop could call the websocket easily.
Please note that all public methods of WebSocket have to be invoked on Cocos Thread.
◆ ErrorCode
ErrorCode enum used to represent the error in the websocket.
Enumerator |
---|
CONNECTION_FAILURE | < value 0
|
UNKNOWN | < value 1
|
◆ State
State enum used to represent the Websocket state.
Enumerator |
---|
OPEN | < value 0
|
CLOSING | < value 1
|
CLOSED | < value 2
|
◆ WebSocket()
◆ ~WebSocket()
◆ closeAllConnections()
static void closeAllConnections |
( |
| ) |
|
|
static |
Close all connections and wait for all websocket threads to exit.
- Note
- This method has to be invoked on Cocos Thread
◆ init()
bool init |
( |
const Delegate & |
delegate, |
|
|
const std::string & |
url, |
|
|
const std::vector< std::string > * |
protocols = nullptr , |
|
|
const std::string & |
caFilePath = "" |
|
) |
| |
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. |
protocols | The websocket protocols that agree with websocket server |
caFilePath | The ca file path for wss connection |
- Returns
- true: Success, false: Failure. @lua NA
◆ send() [1/2]
void send |
( |
const std::string & |
message | ) |
|
Sends string data to websocket server.
- Parameters
-
message | string data. @lua sendstring |
◆ send() [2/2]
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. @lua sendstring |
◆ close()
Closes the connection to server synchronously.
- Note
- It's a synchronous method, it will not return until websocket thread exits.
◆ closeAsync()
Closes the connection to server asynchronously.
- Note
- It's an asynchronous method, it just notifies websocket thread to exit and returns directly, If using 'closeAsync' to close websocket connection, be careful of not using destructed variables in the callback of 'onClose'.
◆ getReadyState()
The documentation for this class was generated from the following file: