mongoose/docs/c-api/net.h/mg_bind_opt.md

27 lines
1.0 KiB
Markdown
Raw Normal View History

---
title: "mg_bind_opt()"
decl_name: "mg_bind_opt"
symbol_kind: "func"
signature: |
struct mg_connection *mg_bind_opt(struct mg_mgr *mgr, const char *address,
mg_event_handler_t handler,
struct mg_bind_opts opts);
---
2016-07-22 21:41:23 +08:00
Creates a listening connection.
2016-07-22 21:41:23 +08:00
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`
2016-07-22 21:41:23 +08:00
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
2016-07-22 21:41:23 +08:00
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.
2016-07-22 21:41:23 +08:00
Returns a new listening connection or `NULL` on error.
NOTE: The connection remains owned by the manager, do not free().