mongoose/docs/design-concept/intro.md
Dmitry Frank 23122b327c Remove old docs, rename docs_new to docs
It would be probably good idea to also remove tools/docgen.py and
asciidoc.mk, but asciidoc.mk is still mentioned under `cloud/doc`, which
may contain some useful info which we'll need at least to review before
removing.

PUBLISHED_FROM=faf454d4c52a2f07ea8ac084cf0bd11a0c9c9b3b
2016-05-15 22:07:04 +03:00

1.1 KiB

title
Design Concept

Mongoose is a multi-protocol networking library that implements non-blocking, asyncronous IO and provides event-based API. 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 structure, which has a number of fields like socket, event handler function, send/receive buffer, flags, et cetera.

Mongoose usage pattern is to declare and initialize 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 respective events.