8639893f1115bc7f9d58fc197171f2252f546a98
[strongswan.git] / src / libstrongswan / networking / streams / stream_manager.h
1 /*
2 * Copyright (C) 2013 Martin Willi
3 * Copyright (C) 2013 revosec AG
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * for more details.
14 */
15
16 /**
17 * @defgroup stream_manager stream_manager
18 * @{ @ingroup streams
19 */
20
21 #ifndef STREAM_MANAGER_H_
22 #define STREAM_MANAGER_H_
23
24 typedef struct stream_manager_t stream_manager_t;
25
26 #include <library.h>
27 #include <networking/streams/stream_service.h>
28
29 /**
30 * Manages client-server connections and services using stream_t backends.
31 */
32 struct stream_manager_t {
33
34 /**
35 * Create a client-server connection to a service.
36 *
37 * @param uri URI of service to connect to
38 * @return stream instance, NULL on error
39 */
40 stream_t* (*connect)(stream_manager_t *this, char *uri);
41
42 /**
43 * Start a new service under an URI, accept()ing client connections.
44 *
45 * @param uri URI of service to provide
46 * @param backlog size of the backlog queue, as passed to listen()
47 * @param cb callback function invoked for each client connection
48 * @param data user data to pass to callback
49 * @param prio job priority to invoke callback with
50 * @return TRUE if service started, FALSE on failure
51 */
52 bool (*start_service)(stream_manager_t *this, char *uri, int backlog,
53 stream_service_cb_t cb, void *data,
54 job_priority_t prio);
55
56 /**
57 * Stop a service previously create with start_service().
58 *
59 * @param uri URI of service to stop
60 */
61 void (*stop_service)(stream_manager_t *this, char *uri);
62
63 /**
64 * Register a stream backend to the manager.
65 *
66 * @param prefix prefix of URIs to use the backend for
67 * @param create constructor function for the stream
68 */
69 void (*add_stream)(stream_manager_t *this, char *prefix,
70 stream_constructor_t create);
71
72 /**
73 * Unregister stream backends from the manager.
74 *
75 * @param create constructor function passed to add_stream()
76 */
77 void (*remove_stream)(stream_manager_t *this, stream_constructor_t create);
78
79 /**
80 * Register a stream service backend to the manager.
81 *
82 * @param prefix prefix of URIs to use the backend for
83 * @param create constructor function for the stream service
84 */
85 void (*add_service)(stream_manager_t *this, char *prefix,
86 stream_service_constructor_t create);
87
88 /**
89 * Unregister stream service backends from the manager.
90 *
91 * @param create constructor function passed to add_service()
92 */
93 void (*remove_service)(stream_manager_t *this,
94 stream_service_constructor_t create);
95
96 /**
97 * Destroy a stream_manager_t.
98 */
99 void (*destroy)(stream_manager_t *this);
100 };
101
102 /**
103 * Create a stream_manager instance.
104 */
105 stream_manager_t *stream_manager_create();
106
107 #endif /** STREAM_MANAGER_H_ @}*/