From 1875653b341689e4aef42509e0dbf1a7d5b21e2b Mon Sep 17 00:00:00 2001 From: Evelyn Date: Fri, 22 Jul 2016 14:41:23 +0100 Subject: [PATCH] Update mg_bind_opt.md --- docs/c-api/net.h/mg_bind_opt.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/c-api/net.h/mg_bind_opt.md b/docs/c-api/net.h/mg_bind_opt.md index 4fb514bf..93c9a3d2 100644 --- a/docs/c-api/net.h/mg_bind_opt.md +++ b/docs/c-api/net.h/mg_bind_opt.md @@ -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().