BadVPN – Blame information for rev 1

Subversion Repositories:
Rev:
Rev Author Line No. Line
1 office 1 /**
2 * @file StreamRecvConnector.h
3 * @author Ambroz Bizjak <ambrop7@gmail.com>
4 *
5 * @section LICENSE
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. Neither the name of the author nor the
15 * names of its contributors may be used to endorse or promote products
16 * derived from this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
22 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 *
29 * @section DESCRIPTION
30 *
31 * A {@link StreamRecvInterface} layer which allows the input to be
32 * connected and disconnected on the fly.
33 */
34  
35 #ifndef BADVPN_FLOW_STREAMRECVCONNECTOR_H
36 #define BADVPN_FLOW_STREAMRECVCONNECTOR_H
37  
38 #include <stdint.h>
39  
40 #include <base/DebugObject.h>
41 #include <flow/StreamRecvInterface.h>
42  
43 /**
44 * A {@link StreamRecvInterface} layer which allows the input to be
45 * connected and disconnected on the fly.
46 */
47 typedef struct {
48 StreamRecvInterface output;
49 int out_avail;
50 uint8_t *out;
51 StreamRecvInterface *input;
52 DebugObject d_obj;
53 } StreamRecvConnector;
54  
55 /**
56 * Initializes the object.
57 * The object is initialized in not connected state.
58 *
59 * @param o the object
60 * @param pg pending group
61 */
62 void StreamRecvConnector_Init (StreamRecvConnector *o, BPendingGroup *pg);
63  
64 /**
65 * Frees the object.
66 *
67 * @param o the object
68 */
69 void StreamRecvConnector_Free (StreamRecvConnector *o);
70  
71 /**
72 * Returns the output interface.
73 *
74 * @param o the object
75 * @return output interface
76 */
77 StreamRecvInterface * StreamRecvConnector_GetOutput (StreamRecvConnector *o);
78  
79 /**
80 * Connects input.
81 * The object must be in not connected state.
82 * The object enters connected state.
83 *
84 * @param o the object
85 * @param output input to connect
86 */
87 void StreamRecvConnector_ConnectInput (StreamRecvConnector *o, StreamRecvInterface *input);
88  
89 /**
90 * Disconnects input.
91 * The object must be in connected state.
92 * The object enters not connected state.
93 *
94 * @param o the object
95 */
96 void StreamRecvConnector_DisconnectInput (StreamRecvConnector *o);
97  
98 #endif