diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-27 18:24:20 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-27 18:24:20 +0000 |
| commit | 483eb2f56657e8e7f419ab1a4fab8dce9ade8609 (patch) | |
| tree | e5d88d25d870d5dedacb6bbdbe2a966086a0a5cf /src/civetweb/docs/api/mg_client_options.md | |
| parent | Initial commit. (diff) | |
| download | ceph-483eb2f56657e8e7f419ab1a4fab8dce9ade8609.tar.xz ceph-483eb2f56657e8e7f419ab1a4fab8dce9ade8609.zip | |
Adding upstream version 14.2.21.upstream/14.2.21upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/civetweb/docs/api/mg_client_options.md')
| -rw-r--r-- | src/civetweb/docs/api/mg_client_options.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/src/civetweb/docs/api/mg_client_options.md b/src/civetweb/docs/api/mg_client_options.md new file mode 100644 index 00000000..f3b9b682 --- /dev/null +++ b/src/civetweb/docs/api/mg_client_options.md @@ -0,0 +1,21 @@ +# Civetweb API Reference + +### `struct mg_client_options;` + +### Fields + +| Field | Type | Description | +| :--- | :--- | :--- | +|**`host`**|`const char *`|The hostname or IP address to connect to| +|**`port`**|`int`|The port on the server| +|**`client_cert`**|`const char *`|Pointer to client certificate| +|**`server_cert`**|`const char *`|Pointer to a server certificate| + +### Description + +The the `mgclient_options` structure contains host and security information to connect as a client to another host. A parameter of this type is used in the call to the function [`mg_connect_client_secure();`](mg_connect_client_secure.md). Please note that IPv6 addresses are only permitted if IPv6 support was enabled during compilation. You can use the function [`mg_check_feature()`](mg_check_feature.md) with the parameter `USE_IPV6` while running your application to check if IPv6 is supported. + +### See Also + +* [`mg_check_feature();`](mg_check_feature.md) +* [`mg_connect_client_secure();`](mg_connect_client_secure.md) |