lws-smd.h

Go to the documentation of this file.

/*
 * lws System Message Distribution
 *
 * Copyright (C) 2010 - 2020 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.
 */
 
#define LWS_SMD_MAX_PAYLOAD             384
#define LWS_SMD_CLASS_BITFIELD_BYTES    4
 
#define LWS_SMD_STREAMTYPENAME          "_lws_smd"
#define LWS_SMD_SS_RX_HEADER_LEN        16
 
typedef uint32_t lws_smd_class_t;
 
struct lws_smd_msg; /* opaque */
struct lws_smd_peer; /* opaque */
 
/*
 * Well-known device classes
 */
 
enum {
        LWSSMDCL_INTERACTION                                    = (1 << 0),
        LWSSMDCL_SYSTEM_STATE                                   = (1 << 1),
        LWSSMDCL_NETWORK                                        = (1 << 2),
        LWSSMDCL_METRICS                                        = (1 << 3),
 
        LWSSMDCL_USER_BASE_BITNUM                               = 24
};

LWS_VISIBLE LWS_EXTERN void * /* payload */
lws_smd_msg_alloc(struct lws_context *ctx, lws_smd_class_t _class, size_t len);

LWS_VISIBLE LWS_EXTERN void
lws_smd_msg_free(void **payload);

LWS_VISIBLE LWS_EXTERN int
lws_smd_msg_send(struct lws_context *ctx, void *payload);

LWS_VISIBLE LWS_EXTERN int
lws_smd_msg_printf(struct lws_context *ctx, lws_smd_class_t _class,
                   const char *format, ...) LWS_FORMAT(3);

 
struct lws_ss_handle;
LWS_VISIBLE LWS_EXTERN int
lws_smd_ss_msg_printf(const char *tag, uint8_t *buf, size_t *len,
                      lws_smd_class_t _class, const char *format, ...)
                      LWS_FORMAT(5);

LWS_VISIBLE LWS_EXTERN int
lws_smd_ss_rx_forward(void *ss_user, const uint8_t *buf, size_t len);
 
LWS_VISIBLE LWS_EXTERN int
lws_smd_sspc_rx_forward(void *ss_user, const uint8_t *buf, size_t len);
 
typedef int (*lws_smd_notification_cb_t)(void *opaque, lws_smd_class_t _class,
                                         lws_usec_t timestamp, void *buf,
                                         size_t len);
 
#define LWSSMDREG_FLAG_PROXIED_SS       (1 << 0)
 
/*
 * lws_smd_register() - register to receive smd messages
 *
 * \param ctx: the lws_context
 * \param opaque: an opaque pointer handed to the callback
 * \param flags: typically 0
 * \param _class_filter: bitmap of message classes we care about
 * \param cb: the callback to receive messages
 *
 * Queues an allocated, prepared message for delivery to smd clients.
 *
 * Returns NULL on failure, or an opaque handle which may be given to
 * lws_smd_unregister() to stop participating in the shared message queue.
 *
 * This is threadsafe to call from a non-service thread.
 */
 
LWS_VISIBLE LWS_EXTERN struct lws_smd_peer *
lws_smd_register(struct lws_context *ctx, void *opaque, int flags,
                 lws_smd_class_t _class_filter, lws_smd_notification_cb_t cb);
 
/*
 * lws_smd_unregister() - unregister receiving smd messages
 *
 * \param pr: the handle returned from the registration
 *
 * Destroys the registration of the callback for messages and ability to send
 * messages.
 *
 * It's not necessary to call this if the registration wants to survive for as
 * long as the lws_context... lws_context_destroy will also clean up any
 * registrations still active by then.
 */
 
LWS_VISIBLE LWS_EXTERN void
lws_smd_unregister(struct lws_smd_peer *pr);