lib/libhttp
1
0
Fork 0
mirror of https://github.com/lammertb/libhttp.git synced 2025-12-22 04:02:04 +03:00
Code Activity

Rename API function introduced by last merge, and document it

Browse Source
This commit is contained in:
bel
2014-11-02 23:10:02 +01:00
parent 0350373c76
commit 6a09b72814
1 changed files with 18 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
include/civetweb.h
View File

@@ -580,7 +580,7 @@ CIVETWEB_API int mg_strncasecmp(const char *s1, const char *s2, size_t len);
host: host to connect to, i.e. "echo.websocket.org" or "192.168.1.1" or "localhost" host: host to connect to, i.e. "echo.websocket.org" or "192.168.1.1" or "localhost"
port: server port port: server port
use_ssl: make a secure connection to server use_ssl: make a secure connection to server
error_buffer, error_buffer_size: error message placeholder. error_buffer, error_buffer_size: buffer for an error message
path: server path you are trying to connect to, i.e. if connection to localhost/app, path should be "/app" path: server path you are trying to connect to, i.e. if connection to localhost/app, path should be "/app"
origin: value of the Origin HTTP header origin: value of the Origin HTTP header
data_func: callback that should be used when data is received from the server data_func: callback that should be used when data is received from the server
@@ -588,7 +588,8 @@ CIVETWEB_API int mg_strncasecmp(const char *s1, const char *s2, size_t len);
Return: Return:
On success, valid mg_connection object. On success, valid mg_connection object.
On error, NULL. */ On error, NULL. Se error_buffer for details.
*/
typedef int (*websocket_data_func)(struct mg_connection *, int bits, typedef int (*websocket_data_func)(struct mg_connection *, int bits,
char *data, size_t data_len); char *data, size_t data_len);
@@ -601,10 +602,22 @@ CIVETWEB_API struct mg_connection *mg_connect_websocket_client(const char *host,
websocket_data_func data_func, websocket_close_func close_func, websocket_data_func data_func, websocket_close_func close_func,
void * user_data); void * user_data);
CIVETWEB_API struct mg_connection *mg_connect(const char *host, int port, int use_ssl, /* Connect to a TCP server as a client (can be used to connect to a HTTP server)
char *ebuf, size_t ebuf_len); Parameters:
host: host to connect to, i.e. "www.wikipedia.org" or "192.168.1.1" or "localhost"
port: server port
use_ssl: make a secure connection to server
error_buffer, error_buffer_size: buffer for an error message
CIVETWEB_API int mg_getreq(struct mg_connection *conn, char *ebuf, size_t ebuf_len); Return:
On success, valid mg_connection object.
On error, NULL. Se error_buffer for details.
*/
CIVETWEB_API struct mg_connection *mg_connect_client(const char *host, int port, int use_ssl,
char *error_buffer, size_t error_buffer_size);
/* TODO: */
/* CIVETWEB_API int mg_getreq(struct mg_connection *conn, char *ebuf, size_t ebuf_len); */
#ifdef __cplusplus #ifdef __cplusplus
} }