diff options
Diffstat (limited to 'src/civetweb/docs/api/mg_server_ports.md')
| -rw-r--r-- | src/civetweb/docs/api/mg_server_ports.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/src/civetweb/docs/api/mg_server_ports.md b/src/civetweb/docs/api/mg_server_ports.md new file mode 100644 index 00000000..e969f032 --- /dev/null +++ b/src/civetweb/docs/api/mg_server_ports.md @@ -0,0 +1,24 @@ +# Civetweb API Reference + +### `struct mg_server_ports;` + +### Fields + +| Field | Type | Description | +| :--- | :--- | :--- | +|**`protocol`**|`int`|The protocol mask where `IPv4` is **1**, `IPv6` is **2** and both `IPv4` and `IPv6` is **3**| +|**`port`**|`int`|The port number on which the service listens| +|**`is_ssl`**|`int`|**0** for `HTTP` communication, **1** for `HTTPS`| +|**`is_redirect`**|`int`|**1** if all requests are redirected, otherwise **0**| +|**`_reserved1`**|`int`|Reserved for internal use| +|**`_reserved2`**|`int`|Reserved for internal use| +|**`_reserved3`**|`int`|Reserved for internal use| +|**`_reserved4`**|`int`|Reserved for internal use| + +### Description + +A call to the function [`mg_get_server_ports()`](mg_get_server_ports.md) returns a list of structures with information about each running Civetweb service. These structures are of type `struct mg_server_ports` and contain the base information of each service. + +### See Also + +* [`mg_get_server_ports();`](mg_get_server_ports.md) |