mirror of
https://github.com/cesanta/mongoose.git
synced 2026-10-21 11:30:01 +00:00
Document %.*Q
PUBLISHED_FROM=5dc567f8978d5414835f7a2338a78ae9eb683f55
This commit is contained in:
1 parent
1c80fc28ee
commit
2c83a50a8a
4 files changed
+19
-19
No files matched your search
@@ -8,22 +8,22 @@ items:
|
||||
---
|
||||
|
||||
Mongoose is a multi-protocol networking library that implements non-blocking,
|
||||
asyncronous IO and provides event-based API. It has three basic data
|
||||
asyncronous IO and provides event-based APIs. It has three basic data
|
||||
structures:
|
||||
|
||||
- `struct mg_mgr` is an event manager that holds all active connections
|
||||
- `struct mg_connection` describes a connection
|
||||
- `struct mbuf` describes data buffer (received or sent data)
|
||||
|
||||
Connections could be either *listening*, *outbound* or *inbound*. Outbound
|
||||
connections are created by `mg_connect()` call. Listening connections are
|
||||
created by `mg_bind()` call. Inbound connections are those accepted by a
|
||||
listening connection. Each connection is described by `struct mg_connection`
|
||||
Connections could be either *listening*, *outbound* or *inbound*. Outbound
|
||||
connections are created by the `mg_connect()` call. Listening connections are
|
||||
created by the `mg_bind()` call. Inbound connections are those accepted by a
|
||||
listening connection. Each connection is described by the `struct mg_connection`
|
||||
structure, which has a number of fields like socket, event handler function,
|
||||
send/receive buffer, flags, et cetera.
|
||||
send/receive buffer, flags, etc.
|
||||
|
||||
Mongoose usage pattern is to declare and initialize event manager, create
|
||||
Mongoose's usage pattern is to declare and initialise event manager, create
|
||||
connections and create an event loop by calling `mg_mgr_poll()` in a loop.
|
||||
`mg_mgr_poll()` iterates over all sockets, accepts new connections, sends and
|
||||
receives data, closes connections, and calls event handler functions for the
|
||||
receives data, closes connections and calls event handler functions for the
|
||||
respective events.
|
||||
@@ -2,13 +2,13 @@
|
||||
title: Memory buffers
|
||||
---
|
||||
|
||||
Each connection has send and receive buffer, `struct mg_connection::send_mbuf`
|
||||
and `struct mg_connection::recv_mbuf` respectively. When data arrives,
|
||||
Mongoose appends received data to the `recv_mbuf` and triggers `MG_EV_RECV`
|
||||
event. User may send data back by calling one of the output functions, like
|
||||
Each connection has a send and receive buffer, `struct mg_connection::send_mbuf`
|
||||
and `struct mg_connection::recv_mbuf` respectively. When data arrives,
|
||||
Mongoose appends received data to the `recv_mbuf` and triggers an `MG_EV_RECV`
|
||||
event. The user may send data back by calling one of the output functions, like
|
||||
`mg_send()` or `mg_printf()`. Output functions append data to the `send_mbuf`.
|
||||
When Mongoose successfully writes data to the socket, it discards data from
|
||||
`struct mg_connection::send_mbuf` and sends `MG_EV_SEND` event. When connection
|
||||
is closed, `MG_EV_CLOSE` event is sent.
|
||||
`struct mg_connection::send_mbuf` and sends an `MG_EV_SEND` event. When the connection
|
||||
is closed, an `MG_EV_CLOSE` event is sent.
|
||||
|
||||

|
||||
Reference in new issue
Block a user