Commit 762a68a0 authored by Sergey Lyubka's avatar Sergey Lyubka

Moved some docs to markdown

parent 1da09867
...@@ -158,11 +158,22 @@ Return: 1 on success, 0 on error. ...@@ -158,11 +158,22 @@ Return: 1 on success, 0 on error.
int mg_write(struct mg_connection *, const void *buf, int len); int mg_write(struct mg_connection *, const void *buf, int len);
Send data to the client. This function attempts to send all requested data, Send data to the client. This function guarantees to send all requested data.
unlike `write()` standard library call, which might send only a portion of If more then one thread is writing to the connection, writes must be
requested data. serialized by e.g. using mutex.
Return: number of bytes written to the client. If return value is less then Return: number of bytes written to the client. If return value is less then
`len`, client has closed the connection. `len`, it is a failure, meaning that client has closed the connection.
int mg_websocket_write(struct mg_connection* conn, int opcode,
const char *data, size_t data_len);
Send data to a websocket client. If more then one thread is writing to the
connection, writes must be serialized by e.g. using mutex. This function
guarantees to send all data (semantic is similar to `mg_write()`).
This function is available when mongoose is compiled with `-DUSE_WEBSOCKET`.
Return: number of bytes written to the client. If return value is less then
`data_len`, it is a failure, meaning that client has closed the connection.
## Embedding Examples ## Embedding Examples
......
...@@ -72,28 +72,9 @@ void mg_stop(struct mg_context *); ...@@ -72,28 +72,9 @@ void mg_stop(struct mg_context *);
void mg_websocket_handshake(struct mg_connection *); void mg_websocket_handshake(struct mg_connection *);
int mg_websocket_read(struct mg_connection *, int *bits, char **data); int mg_websocket_read(struct mg_connection *, int *bits, char **data);
const char *mg_get_option(const struct mg_context *ctx, const char *name);
const char **mg_get_valid_option_names(void);
int mg_modify_passwords_file(const char *passwords_file_name,
const char *domain,
const char *user,
const char *password);
int mg_write(struct mg_connection *, const void *buf, int len);
// Send data to a websocket client wrapped in a websocket frame.
// It is unsafe to read/write to this connection from another thread.
// This function is available when mongoose is compiled with -DUSE_WEBSOCKET
//
// Return:
// 0 when the connection has been closed
// -1 on error
// >0 number of bytes written on success
int mg_websocket_write(struct mg_connection* conn, int opcode, int mg_websocket_write(struct mg_connection* conn, int opcode,
const char *data, size_t data_len); const char *data, size_t data_len);
// Websocket opcodes, from http://tools.ietf.org/html/rfc6455
// Opcodes, from http://tools.ietf.org/html/rfc6455
enum { enum {
WEBSOCKET_OPCODE_CONTINUATION = 0x0, WEBSOCKET_OPCODE_CONTINUATION = 0x0,
WEBSOCKET_OPCODE_TEXT = 0x1, WEBSOCKET_OPCODE_TEXT = 0x1,
...@@ -103,6 +84,13 @@ enum { ...@@ -103,6 +84,13 @@ enum {
WEBSOCKET_OPCODE_PONG = 0xa WEBSOCKET_OPCODE_PONG = 0xa
}; };
const char *mg_get_option(const struct mg_context *ctx, const char *name);
const char **mg_get_valid_option_names(void);
int mg_modify_passwords_file(const char *passwords_file_name,
const char *domain,
const char *user,
const char *password);
int mg_write(struct mg_connection *, const void *buf, int len);
// Macros for enabling compiler-specific checks for printf-like arguments. // Macros for enabling compiler-specific checks for printf-like arguments.
#undef PRINTF_FORMAT_STRING #undef PRINTF_FORMAT_STRING
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment