lws-ws-ext.h

Go to the documentation of this file.

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

 
/*
 * NOTE: These public enums are part of the abi.  If you want to add one,
 * add it at where specified so existing users are unaffected.
 */
enum lws_extension_callback_reasons {
        LWS_EXT_CB_CONSTRUCT                                =  4,
        LWS_EXT_CB_CLIENT_CONSTRUCT                  =  5,
        LWS_EXT_CB_DESTROY                            =  8,
        LWS_EXT_CB_PACKET_TX_PRESEND                        = 12,
        LWS_EXT_CB_PAYLOAD_TX                              = 21,
        LWS_EXT_CB_PAYLOAD_RX                              = 22,
        LWS_EXT_CB_OPTION_DEFAULT                      = 23,
        LWS_EXT_CB_OPTION_SET                              = 24,
        LWS_EXT_CB_OPTION_CONFIRM                      = 25,
        LWS_EXT_CB_NAMED_OPTION_SET                  = 26,
 
        /****** add new things just above ---^ ******/
};

enum lws_ext_options_types {
        EXTARG_NONE, 
        EXTARG_DEC,  
        EXTARG_OPT_DEC 
 
        /* Add new things just above here ---^
         * This is part of the ABI, don't needlessly break compatibility */
};

struct lws_ext_options {
        const char *name; 
        enum lws_ext_options_types type; 
 
        /* Add new things just above here ---^
         * This is part of the ABI, don't needlessly break compatibility */
};

struct lws_ext_option_arg {
        const char *option_name; 
        int option_index; 
        const char *start; 
        int len; 
};

typedef int
lws_extension_callback_function(struct lws_context *context,
                              const struct lws_extension *ext, struct lws *wsi,
                              enum lws_extension_callback_reasons reason,
                              void *user, void *in, size_t len);

struct lws_extension {
        const char *name; 
        lws_extension_callback_function *callback; 
        const char *client_offer; 
 
        /* Add new things just above here ---^
         * This is part of the ABI, don't needlessly break compatibility */
};

LWS_VISIBLE LWS_EXTERN int
lws_set_extension_option(struct lws *wsi, const char *ext_name,
                         const char *opt_name, const char *opt_val);

LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
lws_ext_parse_options(const struct lws_extension *ext, struct lws *wsi,
                      void *ext_user, const struct lws_ext_options *opts,
                      const char *o, int len);

LWS_VISIBLE LWS_EXTERN int
lws_extension_callback_pm_deflate(struct lws_context *context,
                                  const struct lws_extension *ext,
                                  struct lws *wsi,
                                  enum lws_extension_callback_reasons reason,
                                  void *user, void *in, size_t len);
 
/*
 * The internal exts are part of the public abi
 * If we add more extensions, publish the callback here  ------v
 */