lws-system.h

/*
 * libwebsockets - small server side websockets and web server implementation
 *
 * Copyright (C) 2010-2019 Andy Green <andy@warmcat.com>
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation:
 *  version 2.1 of the License.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 *  MA  02110-1301  USA
 *
 * included from libwebsockets.h
 *
 * This provides a clean way to interface lws user code to be able to
 * work unchanged on different systems for fetching common system information,
 * and performing common system operations like reboot.
 *
 * An ops struct with the system-specific implementations is set at
 * context creation time, and apis are provided that call through to
 * those where they exist.
 */
 
typedef enum {
        LWS_SYSI_HRS_DEVICE_MODEL = 1,
        LWS_SYSI_HRS_DEVICE_SERIAL,
        LWS_SYSI_HRS_FIRMWARE_VERSION,
 
        LWS_SYSI_USER_BASE = 100
} lws_system_item_t;
 
typedef union {
        const char      *hrs;   /* human readable string */
        void            *data;
        time_t          t;
} lws_system_arg_t;
 
typedef struct lws_system_ops {
        int (*get_info)(lws_system_item_t i, lws_system_arg_t arg, size_t *len);
        int (*reboot)(void);
} lws_system_ops_t;
 
/* wrappers handle NULL members or no ops struct set at all cleanly */
 
LWS_EXTERN LWS_VISIBLE int
lws_system_get_info(struct lws_context *context, lws_system_item_t item,
                    lws_system_arg_t arg, size_t *len);
 
 
LWS_EXTERN LWS_VISIBLE int
lws_system_reboot(struct lws_context *context);