9d2c7a82212f6a7bbee46bff0ff149f1fa5701e7
[oonf.git] / src-plugins / generic / dlep / router / dlep_router_session.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon version 2 (olsrd2)
4  * Copyright (c) 2004-2015, the olsr.org team - see HISTORY file
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  *   notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright
14  *   notice, this list of conditions and the following disclaimer in
15  *   the documentation and/or other materials provided with the
16  *   distribution.
17  * * Neither the name of olsr.org, olsrd nor the names of its
18  *   contributors may be used to endorse or promote products derived
19  *   from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  * Visit http://www.olsr.org for more information.
35  *
36  * If you find this software useful feel free to make a donation
37  * to the project. For more information see the website or contact
38  * the copyright holders.
39  *
40  */
41
42 /**
43  * @file
44  */
45
46 #ifndef DLEP_ROUTER_SESSION_H_
47 #define DLEP_ROUTER_SESSION_H_
48
49 #include "common/avl.h"
50 #include "common/common_types.h"
51 #include "common/netaddr.h"
52 #include "subsystems/oonf_stream_socket.h"
53 #include "subsystems/oonf_timer.h"
54
55 #include "dlep/router/dlep_router_interface.h"
56
57 /**
58  * session state of a router
59  */
60 enum dlep_router_session_state
61 {
62   /*! session is still initializing */
63   DLEP_ROUTER_SESSION_INIT,
64
65   /*! session is active */
66   DLEP_ROUTER_SESSION_ACTIVE,
67
68   /*! session is being terminated */
69   DLEP_ROUTER_SESSION_TERMINATE,
70 };
71
72 /**
73  * DLEP session of a router
74  */
75 struct dlep_router_session {
76   /*! basic struct for tcp stream */
77   struct oonf_stream_session *stream;
78
79   /*! TCP client socket for session */
80   struct oonf_stream_socket tcp;
81
82   /*! generic DLEP session */
83   struct dlep_session session;
84
85   /*! back pointer to interface session */
86   struct dlep_router_if *interface;
87
88   /*! remember all streams bound to an interface */
89   struct avl_node _node;
90 };
91
92 void dlep_router_session_init(void);
93 void dlep_router_session_cleanup(void);
94
95 struct dlep_router_session *dlep_router_get_session(struct dlep_router_if *interf, union netaddr_socket *remote);
96 struct dlep_router_session *dlep_router_add_session(
97   struct dlep_router_if *interf, union netaddr_socket *local, union netaddr_socket *remote);
98 void dlep_router_remove_session(struct dlep_router_session *);
99
100 #endif /* DLEP_ROUTER_SESSION_H_ */