ceph/src/jaegertracing/opentelemetry-cpp/third_party/prometheus-cpp/3rdparty/civetweb/docs/api/mg_get_connection_info.md

   1 # Civetweb API Reference
   2
   3 ### `mg_get_connection_info( ctx, idx, buffer, buflen );`
   4
   5 ### Parameters
   6
   7 | Parameter | Type | Description |
   8 | :--- | :--- | :--- |
   9 |**`ctx`**|`struct mg_context *`|The server context handle|
  10 |**`idx`**|`int`|Connection index within the context|
  11 |**`buffer**|`char *`|A string buffer to store the information|
  12 |**`buflen**|`int`|Size of the string buffer (including space for a terminating 0)|
  13
  14 ### Return Value
  15
  16 | Type | Description |
  17 | :--- | :--- |
  18 |`int`|Available context information in bytes (excluding the terminating 0)|
  19
  20 ### Description
  21
  22 The function `mg_get_connection_info()` returns statistics information collected for
  23 a server connection index.  This may be empty if the server has not been built with
  24 statistics support (`#define USE_SERVER_STATS`).
  25 If data is available, the returned string is in JSON format. The exact content may
  26 vary, depending on the connection state and server version.
  27
  28 ### Note
  29
  30 This is an experimental interface and may be changed, replaced
  31 or even removed in the future. Currently the index `idx` must be
  32 between `0` and `num_threads-1`. The thread is not locked for
  33 performance reasons, so the information may be inconsistent
  34 in rare cases.
  35
  36 ### See Also
  37
  38 * [`mg_get_system_info();`](mg_get_system_info.md)
  39 * [`mg_get_context_info();`](mg_get_context_info.md)
  40