lws-protocols-plugins.h

/*
 * libwebsockets - small server side websockets and web server implementation
 *
 * Copyright (C) 2010-2018 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
 */
 
 
struct lws_protocols {
        const char *name;
        lws_callback_function *callback;
        size_t per_session_data_size;
        size_t rx_buffer_size;
        unsigned int id;
        void *user; 
        size_t tx_packet_size;
        /* Add new things just above here ---^
         * This is part of the ABI, don't needlessly break compatibility */
};
 
LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
lws_vhost_name_to_protocol(struct lws_vhost *vh, const char *name);
 
LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
lws_get_protocol(struct lws *wsi);
 
LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
lws_protocol_get(struct lws *wsi) LWS_WARN_DEPRECATED;
 
LWS_VISIBLE LWS_EXTERN void *
lws_protocol_vh_priv_zalloc(struct lws_vhost *vhost,
                            const struct lws_protocols *prot, int size);
 
LWS_VISIBLE LWS_EXTERN void *
lws_protocol_vh_priv_get(struct lws_vhost *vhost,
                         const struct lws_protocols *prot);
 
LWS_VISIBLE LWS_EXTERN void *
lws_adjust_protocol_psds(struct lws *wsi, size_t new_size);
 
LWS_VISIBLE LWS_EXTERN int
lws_finalize_startup(struct lws_context *context);
 
LWS_VISIBLE LWS_EXTERN const struct lws_protocol_vhost_options *
lws_pvo_search(const struct lws_protocol_vhost_options *pvo, const char *name);
 
LWS_VISIBLE LWS_EXTERN int
lws_pvo_get_str(void *in, const char *name, const char **result);
 
LWS_VISIBLE LWS_EXTERN int
lws_protocol_init(struct lws_context *context);
 
#ifdef LWS_WITH_PLUGINS
 
/* PLUGINS implies LIBUV */
 
#define LWS_PLUGIN_API_MAGIC 180
 
struct lws_plugin_capability {
        unsigned int api_magic; 
        const struct lws_protocols *protocols; 
        int count_protocols; 
        const struct lws_extension *extensions; 
        int count_extensions; 
};
 
typedef int (*lws_plugin_init_func)(struct lws_context *,
                                    struct lws_plugin_capability *);
typedef int (*lws_plugin_destroy_func)(struct lws_context *);
 
struct lws_plugin {
        struct lws_plugin *list; 
#if (UV_VERSION_MAJOR > 0)
        uv_lib_t lib; 
#else
        void *l; 
#endif
        char name[64]; 
        struct lws_plugin_capability caps; 
};
 
#endif