[ceph.git] / ceph / src / civetweb / docs / api / mg_server_ports.md

# 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)
Commit	Line	Data
11fdf7f2 TL	1	# Civetweb API Reference
	2
	3	### `struct mg_server_ports;`
	4
	5	### Fields
	6
	7	\| Field \| Type \| Description \|
	8	\| :--- \| :--- \| :--- \|
	9	\|`protocol`\|`int`\|The protocol mask where `IPv4` is 1, `IPv6` is 2 and both `IPv4` and `IPv6` is 3\|
	10	\|`port`\|`int`\|The port number on which the service listens\|
	11	\|`is_ssl`\|`int`\|0 for `HTTP` communication, 1 for `HTTPS`\|
	12	\|`is_redirect`\|`int`\|1 if all requests are redirected, otherwise 0\|
	13	\|`_reserved1`\|`int`\|Reserved for internal use\|
	14	\|`_reserved2`\|`int`\|Reserved for internal use\|
	15	\|`_reserved3`\|`int`\|Reserved for internal use\|
	16	\|`_reserved4`\|`int`\|Reserved for internal use\|
	17
	18	### Description
	19
	20	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.
	21
	22	### See Also
	23
	24	* [`mg_get_server_ports();`](mg_get_server_ports.md)