mirror/mongoose
1
0
Fork 0
mirror of https://github.com/cesanta/mongoose.git synced 2024-11-24 11:09:01 +08:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

Docs notes

Browse Source
This commit is contained in:
cpq 2023-02-16 16:41:26 +00:00
parent cf452942fa
commit ca3dfb3c07
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/README.md
View File

@ -79,6 +79,10 @@ int main() {
**Step 3.** Add `mongoose.c` to the build and recompile - and that is it! **Step 3.** Add `mongoose.c` to the build and recompile - and that is it!
> NOTE: If you're building for some embedded systems, you may need to add
> some extra compilation flags, for example on FreeRTOS it would be
> `-DMG_ARCH=MG_ARCH_FREERTOS`. See [Build options](#build-options) below.
`mg_mgr_poll()` iterates over all connections, accepts new connections, sends and `mg_mgr_poll()` iterates over all connections, 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
@ -91,11 +95,9 @@ protocol-specific handler function that is set implicitly. For example, a
protocol-specific handler is called before a user-specific handler. It parses protocol-specific handler is called before a user-specific handler. It parses
incoming data and may invoke protocol-specific events like `MG_EV_HTTP_MSG`. incoming data and may invoke protocol-specific events like `MG_EV_HTTP_MSG`.
> NOTE: Since Mongoose's core is not protected against concurrent accesses,
<span class="badge bg-danger">NOTE:</span> > make sure that all `mg_*` API functions are called from the same thread or
Since Mongoose's core is not protected against concurrent accesses, make > RTOS task.
sure that all `mg_*` API functions are called from the same thread or RTOS
task.
## Connections and event manager ## Connections and event manager