libwebsockets
Lightweight C library for HTML5 websockets
lws-protocols-plugins.h
1 /*
2  * libwebsockets - small server side websockets and web server implementation
3  *
4  * Copyright (C) 2010 - 2019 Andy Green <andy@warmcat.com>
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
22  * IN THE SOFTWARE.
23  */
24 
40 
44 struct lws_protocols {
45  const char *name;
66  unsigned int id;
73  void *user;
85  /* Add new things just above here ---^
86  * This is part of the ABI, don't needlessly break compatibility */
87 };
88 
97 LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
98 lws_vhost_name_to_protocol(struct lws_vhost *vh, const char *name);
99 
109 LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
110 lws_get_protocol(struct lws *wsi);
111 
113 LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
114 lws_protocol_get(struct lws *wsi) LWS_WARN_DEPRECATED;
115 
126 LWS_VISIBLE LWS_EXTERN void *
127 lws_protocol_vh_priv_zalloc(struct lws_vhost *vhost,
128  const struct lws_protocols *prot, int size);
129 
139 LWS_VISIBLE LWS_EXTERN void *
140 lws_protocol_vh_priv_get(struct lws_vhost *vhost,
141  const struct lws_protocols *prot);
142 
157 LWS_VISIBLE LWS_EXTERN void *
158 lws_adjust_protocol_psds(struct lws *wsi, size_t new_size);
159 
168 LWS_VISIBLE LWS_EXTERN int
169 lws_finalize_startup(struct lws_context *context);
170 
179 LWS_VISIBLE LWS_EXTERN const struct lws_protocol_vhost_options *
180 lws_pvo_search(const struct lws_protocol_vhost_options *pvo, const char *name);
181 
191 LWS_VISIBLE LWS_EXTERN int
192 lws_pvo_get_str(void *in, const char *name, const char **result);
193 
194 LWS_VISIBLE LWS_EXTERN int
195 lws_protocol_init(struct lws_context *context);
196 
197 #ifdef LWS_WITH_PLUGINS
198 
199 /* PLUGINS implies LIBUV */
200 
201 #define LWS_PLUGIN_API_MAGIC 180
202 
204 struct lws_plugin_capability {
205  unsigned int api_magic;
206  const struct lws_protocols *protocols;
207  int count_protocols;
208  const struct lws_extension *extensions;
209  int count_extensions;
210 };
211 
212 typedef int (*lws_plugin_init_func)(struct lws_context *,
213  struct lws_plugin_capability *);
214 typedef int (*lws_plugin_destroy_func)(struct lws_context *);
215 
217 struct lws_plugin {
218  struct lws_plugin *list;
219 #if (UV_VERSION_MAJOR > 0)
220  uv_lib_t lib;
221 #endif
222  void *l;
223  char name[64];
224  struct lws_plugin_capability caps;
225 };
226 
227 #endif
228 
size_t rx_buffer_size
Definition: lws-protocols-plugins.h:57
LWS_VISIBLE LWS_EXTERN const struct lws_protocol_vhost_options * lws_pvo_search(const struct lws_protocol_vhost_options *pvo, const char *name)
unsigned int id
Definition: lws-protocols-plugins.h:66
lws_callback_function * callback
Definition: lws-protocols-plugins.h:48
Definition: lws-context-vhost.h:1005
Definition: lws-ws-ext.h:139
LWS_VISIBLE LWS_EXTERN void * lws_adjust_protocol_psds(struct lws *wsi, size_t new_size)
LWS_VISIBLE LWS_EXTERN int lws_pvo_get_str(void *in, const char *name, const char **result)
const char * name
Definition: lws-context-vhost.h:1008
LWS_VISIBLE LWS_EXTERN void * lws_protocol_vh_priv_zalloc(struct lws_vhost *vhost, const struct lws_protocols *prot, int size)
size_t tx_packet_size
Definition: lws-protocols-plugins.h:75
size_t per_session_data_size
Definition: lws-protocols-plugins.h:52
Definition: lws-protocols-plugins.h:44
LWS_VISIBLE LWS_EXTERN const struct lws_protocols * lws_get_protocol(struct lws *wsi)
LWS_VISIBLE LWS_EXTERN int lws_finalize_startup(struct lws_context *context)
const char * name
Definition: lws-protocols-plugins.h:45
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_protocol_get(struct lws *wsi) LWS_WARN_DEPRECATED
void * user
Definition: lws-protocols-plugins.h:73
LWS_VISIBLE LWS_EXTERN void * lws_protocol_vh_priv_get(struct lws_vhost *vhost, const struct lws_protocols *prot)
int lws_callback_function(struct lws *wsi, enum lws_callback_reasons reason, void *user, void *in, size_t len)
Definition: lws-callbacks.h:838