1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
/*
* Copyright (C) 2013 Martin Willi
* Copyright (C) 2013 revosec AG
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
*
* This program 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 General Public License
* for more details.
*/
/**
* @defgroup stream_service stream_service
* @{ @ingroup streams
*/
#ifndef STREAM_SERVICE_H_
#define STREAM_SERVICE_H_
typedef struct stream_service_t stream_service_t;
#include <library.h>
#include <processing/jobs/job.h>
#include <networking/streams/stream.h>
/**
* Constructor function prototype for stream_service_t.
*
* @param uri URI to create a stream for
* @param backlog size of the backlog queue, as passed to listen()
* @return stream instance, NULL on error
*/
typedef stream_service_t*(*stream_service_constructor_t)(char *uri, int backlog);
/**
* Service callback routine for accepting client connections.
*
* The passed stream gets closed/destroyed by the callback caller, unless
* TRUE is returned.
*
* @param data user data, as passed during registration
* @param stream accept()ed client connection
* @return TRUE to keep stream alive, FALSE to destroy it
*/
typedef bool (*stream_service_cb_t)(void *data, stream_t *stream);
/**
* A service accepting client connection streams.
*/
struct stream_service_t {
/**
* Start accepting client connections on this stream service.
*
* To stop accepting connections, pass a NULL callback function.
*
* @param cb callback function to call for accepted client streams
* @param data data to pass to callback function
* @param prio job priority to run callback with
* @param cncrncy maximum number of parallel callback invocations
*/
void (*on_accept)(stream_service_t *this,
stream_service_cb_t cb, void *data,
job_priority_t prio, u_int cncrncy);
/**
* Destroy a stream_service_t.
*/
void (*destroy)(stream_service_t *this);
};
/**
* Create a service from a file descriptor.
*
* The file descriptor MUST be a socket.
*
* @param fd file descriptor to wrap into a stream_service_t
* @return stream_service instance
*/
stream_service_t *stream_service_create_from_fd(int fd);
/**
* Create a service instance for UNIX sockets.
*
* @param uri UNIX socket specific URI, must start with "unix://"
* @param backlog size of the backlog queue, as passed to listen()
* @return stream_service instance, NULL on failure
*/
stream_service_t *stream_service_create_unix(char *uri, int backlog);
/**
* Create a service instance for TCP sockets.
*
* @param uri TCP socket specific URI, must start with "tcp://"
* @param backlog size of the backlog queue, as passed to listen()
* @return stream_service instance, NULL on failure
*/
stream_service_t *stream_service_create_tcp(char *uri, int backlog);
#endif /** STREAM_SERVICE_H_ @}*/
|
