• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 
25 /*
26  * Abstract transport ops
27  */
28 
29 typedef struct lws_abs_transport {
30 	const char *name;
31 	int alloc;
32 
33 	int (*create)(lws_abs_t *abs);
34 	void (*destroy)(lws_abs_transport_inst_t **d);
35 
36 	/* check if the transport settings for these connections are the same */
37 	int (*compare)(lws_abs_t *abs1, lws_abs_t *abs2);
38 
39 	/* events the abstract protocol invokes (handled by transport) */
40 
41 	int (*tx)(lws_abs_transport_inst_t *d, uint8_t *buf, size_t len);
42 	int (*client_conn)(const lws_abs_t *abs);
43 	int (*close)(lws_abs_transport_inst_t *d);
44 	int (*ask_for_writeable)(lws_abs_transport_inst_t *d);
45 	int (*set_timeout)(lws_abs_transport_inst_t *d, int reason, int secs);
46 	int (*state)(lws_abs_transport_inst_t *d);
47 } lws_abs_transport_t;
48 
49 /**
50  * lws_abs_protocol_get_by_name() - returns a pointer to the named protocol ops
51  *
52  * \param name: the name of the abstract protocol
53  *
54  * Returns a pointer to the named protocol ops struct if available, otherwise
55  * NULL.
56  */
57 LWS_VISIBLE LWS_EXTERN const lws_abs_transport_t *
58 lws_abs_transport_get_by_name(const char *name);
59 
60 /*
61  * bring in public api pieces from transports
62  */
63 
64 #include <libwebsockets/abstract/transports/raw-skt.h>
65 #include <libwebsockets/abstract/transports/unit-test.h>
66