lws-conmon.h

Go to the documentation of this file.

/*
 * libwebsockets - small server side websockets and web server implementation
 *
 * Copyright (C) 2010 - 2021 Andy Green <andy@warmcat.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

 
/* enough for 4191s, or just over an hour */
typedef uint32_t lws_conmon_interval_us_t;
 
/*
 * Connection latency information... note that not all wsi actually make
 * connections, for example h2 streams after the initial one will have 0
 * for everything except ciu_txn_resp.
 *
 * If represented in JSON, it should look like this
 *
 *     {
 *        "peer": "46.105.127.147",
 *        "dns_us": 1234,
 *        "dns_disp": 1,
 *        "sockconn_us": 1234,
 *        "tls_us": 1234,
 *        "txn_resp_us": 1234,
 *        "dns":["46.105.127.147", "2001:41d0:2:ee93::1"],
 *        "prot_specific": {
 *              "protocol": "http",
 *              "resp": 200
 *        }
 *      }
 *
 * The indexes in "dns_disp" are declared in lws_conmon_dns_disposition_t
 * below.
 *
 * "prot_specific" may not be present if the protocol doesn't have anything
 * to report or is not supported.
 */
 
typedef enum lws_conmon_pcol {
        LWSCONMON_PCOL_NONE,
        LWSCONMON_PCOL_HTTP, /* .protocol_specific.http is valid */
} lws_conmon_pcol_t;
 
typedef enum lws_conmon_dns_disposition {
        LWSCONMON_DNS_NONE,
        LWSCONMON_DNS_OK                                = 1,
        LWSCONMON_DNS_SERVER_UNREACHABLE                = 2,
        LWSCONMON_DNS_NO_RESULT                          = 3
} lws_conmon_dns_disposition_t;
 
struct lws_conmon {
        lws_sockaddr46                            peer46;
 
        union {
                struct {
                        int     response;
                } http;
        } protocol_specific;

 
        struct addrinfo                         *dns_results_copy;
 
        lws_conmon_interval_us_t                ciu_dns;
        lws_conmon_interval_us_t                ciu_sockconn;
        lws_conmon_interval_us_t                ciu_tls;
        lws_conmon_interval_us_t                ciu_txn_resp;
 
        lws_conmon_pcol_t                      pcol;
 
        lws_conmon_dns_disposition_t                dns_disposition;
};

LWS_VISIBLE LWS_EXTERN void
lws_conmon_wsi_take(struct lws *wsi, struct lws_conmon *dest);

LWS_VISIBLE LWS_EXTERN void
lws_conmon_release(struct lws_conmon *conmon);