mirror/mongoose
1
0
Fork 0
mirror of https://github.com/cesanta/mongoose.git synced 2025-08-06 13:37:34 +08:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Sergey Lyubka 2021-08-09 09:43:21 +01:00
parent 11c07470bb
commit b739aa89f1
1 changed files with 15 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/README.md
View File

@ -529,18 +529,23 @@ bool mg_mkpipe(struct mg_connection *c, struct mg_connection *pc[2]);
void mg_rmpipe(struct mg_connection *c);
```
Create a pair of connected connections using UDP socketpair.
A sending connection, `pc[0]`, is safe to give to a different task,
and send data to it. A receiving connection `pc[1]`, forwards all received
data to `c`. A `pc[0]` is not added to event manager, therefore it must be
manually cleaned up by calling `mg_rmpipe()` when sending task is done.
A receiving side, `pc[1]` is added to the event manager, therefore it wakes
up a manager each time data gets sent.
Create a pair of connected connections using UDP socketpair. A sending side of
the pair is `pc[0]`, a receiving side is `pc[1]`. This API is indended for a
multi-threaded usage only.
NOTE: if there is a limit on the local UDP message size, do not send more
than that limit in one call.
A sending connection `pc[0]` should be passed to another task (thread) - in
fact, it is the only data structure that is safe to pass to another task.
`pc[0]` is not added to an event manager, therefore its callback function and
flags are ignored. A task function must write to `pc[0]` using any of the
existing `mg_*` API, then call `mg_rmpipe()` when done. Writing to `pc[0]`
wakes up an event manager, because the receiving side of the pipe `pc[1]` is
added to an event manager.
See examples/multi-threaded for a usage example.
A receiving side `pc[1]` forwards all received data to `c`. NOTE: if
there is a limit on the local UDP message size, do not send more than that
limit in one call.
See [examples/multi-threaded](../examples/multi-threaded) for a usage example.
Return value: true on success, false on error.