Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Contribute to GitLab
Sign in
Toggle navigation
M
mongoose
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
esp
mongoose
Commits
762a68a0
Commit
762a68a0
authored
Oct 30, 2013
by
Sergey Lyubka
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Moved some docs to markdown
parent
1da09867
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
23 additions
and
24 deletions
+23
-24
API.md
docs/API.md
+15
-4
mongoose.h
mongoose.h
+8
-20
No files found.
docs/API.md
View file @
762a68a0
...
@@ -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
...
...
mongoose.h
View file @
762a68a0
...
@@ -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
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment