lws-sysinfo.h

Go to the documentation of this file.

/*
 * libwebsockets - small server side websockets and web server implementation
 *
 * Copyright (C) 2010 - 2026 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.
 */

 
#if defined(LWS_WITH_SYS_INFO)
 
typedef enum lws_sysinfo_type {
        LWS_SYSINFO_LWS_VERSION,        
        LWS_SYSINFO_LWS_BUILD,          
        LWS_SYSINFO_HOSTNAME,           
        LWS_SYSINFO_OS,                 
        LWS_SYSINFO_ARCH,               
        LWS_SYSINFO_PID,                
        LWS_SYSINFO_TIME,               
        LWS_SYSINFO_UPTIME,             
        LWS_SYSINFO_CPUS,               
        LWS_SYSINFO_RAM_TOTAL,          
        LWS_SYSINFO_RAM_FREE,           
        LWS_SYSINFO_IFACE_ADDR,         
        LWS_SYSINFO_DNS_SERVER,         
        LWS_SYSINFO_DNS_SEARCH,         
 
        LWS_SYSINFO_TYPE_COUNT
} lws_sysinfo_type_t;
 
/* the state of an interface an LWS_SYSINFO_IFACE_ADDR address is on */
 
enum {
        LWS_SYSINFO_IF_UP               = (1 << 0),
        LWS_SYSINFO_IF_RUNNING          = (1 << 1),
        LWS_SYSINFO_IF_LOOPBACK         = (1 << 2),
        LWS_SYSINFO_IF_P2P              = (1 << 3),
};
 
typedef struct lws_sysinfo_item {
        lws_dll2_t              list;
        const char              *name;  
        const char              *s;     
        uint64_t                u;      
        lws_sockaddr46          sa46;   
        uint32_t                flags;  
        lws_sysinfo_type_t      type;
} lws_sysinfo_item_t;
 
struct lws_sysinfo;

LWS_VISIBLE LWS_EXTERN struct lws_sysinfo *
lws_sysinfo_create(struct lws_context *cx);

LWS_VISIBLE LWS_EXTERN const lws_sysinfo_item_t *
lws_sysinfo_next(struct lws_sysinfo *si, const lws_sysinfo_item_t *prev);

LWS_VISIBLE LWS_EXTERN int
lws_sysinfo_describe(const lws_sysinfo_item_t *it, char *buf, size_t len);

LWS_VISIBLE LWS_EXTERN const char *
lws_sysinfo_type_name(lws_sysinfo_type_t type);

LWS_VISIBLE LWS_EXTERN void
lws_sysinfo_destroy(struct lws_sysinfo **psi);
 
#endif