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

Update mg_bind_opt.md

Browse Source
This commit is contained in:
Evelyn 2016-07-22 14:41:23 +01:00 committed by GitHub
parent 6df770e72d
commit 1875653b34
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/c-api/net.h/mg_bind_opt.md
View File

@ -8,19 +8,19 @@ signature: |
struct mg_bind_opts opts);
---
Create listening connection.
Creates a listening connection.
`address` parameter tells which address to bind to. It's format is the same
The `address` parameter specifies which address to bind to. It's format is the same
as for the `mg_connect()` call, where `HOST` part is optional. `address`
can be just a port number, e.g. `:8000`. To bind to a specific interface,
can just be a port number, e.g. `:8000`. To bind to a specific interface,
an IP address can be specified, e.g. `1.2.3.4:8000`. By default, a TCP
connection is created. To create UDP connection, prepend `udp://` prefix,
e.g. `udp://:8000`. To summarize, `address` paramer has following format:
connection is created. To create a UDP connection, prepend a `udp://` prefix,
e.g. `udp://:8000`. To summarise, the `address` paramer has following format:
`[PROTO://][IP_ADDRESS]:PORT`, where `PROTO` could be `tcp` or `udp`.
See the `mg_bind_opts` structure for a description of the optional
parameters.
Return a new listening connection, or `NULL` on error.
NOTE: Connection remains owned by the manager, do not free().
Returns a new listening connection or `NULL` on error.
NOTE: The connection remains owned by the manager, do not free().