blob: f838c81d0f99170401c046e7b3b38ef6b92e7af9 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
|
# Civetweb API Reference
### `mg_set_websocket_handler( ctx, uri, connect_handler, ready_handler, data_handler, close_handler, cbdata );`
### Parameters
| Parameter | Type | Description |
| :--- | :--- | :--- |
|**`ctx`**|`mg_context *`|The context in which to add the handlers|
|**`uri`**|`const char *`|The URI for which the handlers should be activated|
|**`connect_handler`**|`mg_websocket_connect_handler`|Handler called when a connect is signalled|
|**`ready_handler`**|`mg_websocket_ready_handler`|Handler called when the connection is ready|
|**`data_handler`**|`mg_websocket_data_handler`|Handler called when data is received|
|**`close_handler`**|`mg_websocket_close_handler`|Handler called when the connection closes|
|**`cbdata`**|`void *`|User defined data|
`int mg_websocket_connect_handler( const struct mg_connection *conn, void *cbdata );`
`int mg_websocket_ready_handler( struct mg_connection *conn, void *cbdata );`
`int mg_websocket_data_handler( struct mg_connection *conn, int opcode, char * buf, size_t buf_len, void *cbdata );`
`int mg_websocket_close_handler( const struct mg_connection *conn, void *cbdata );`
### Return Value
*none*
### Description
The function `mg_set_websocket_handler()` connects callback functions to a websocket URI. The callback functions are called when a state change is detected on the URI like an incomming connection or data received from a remote peer.
### See Also
|
