Add cleanup code for html/telnet server
[olsrd.git] / src / olsr_comport.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004-2009, 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 #ifndef OLSR_COMPORT_H_
42 #define OLSR_COMPORT_H_
43
44 #include "defs.h"
45 #include "common/autobuf.h"
46 #include "common/list.h"
47
48 enum http_header_type {
49   PLAIN,
50   HTTP_PLAIN,
51   HTTP_200_OK = 200,
52   HTTP_400_BAD_REQ = 400,
53   HTTP_401_UNAUTHORIZED = 401,
54   HTTP_403_FORBIDDEN = 403,
55   HTTP_404_NOT_FOUND = 404,
56   HTTP_413_REQUEST_TOO_LARGE = 413,
57   HTTP_501_NOT_IMPLEMENTED = 501,
58   HTTP_503_SERVICE_UNAVAILABLE = 503
59 };
60
61 enum connection_state {
62   HTTP_LOGIN, INTERACTIVE, SEND_AND_QUIT, CLEANUP
63 };
64
65 struct comport_connection;
66 typedef void (*olsr_txt_stop_continous) (struct comport_connection *con);
67
68 struct comport_connection {
69   /*
70    * public part of the session data
71    *
72    * variables marked RW might be written from txt commands, those with
73    * an "R" mark are read only
74    */
75
76   /* timeout for txt sessions (RW) */
77   uint32_t timeout_value;
78
79   /* ip addr of peer (R) */
80   union olsr_ip_addr addr;
81
82   /* true if the txt session is in CSV mode (RW) */
83   bool is_csv;
84
85   /* callback and data to stop a continous output txt command (RW) */
86   olsr_txt_stop_continous stop_handler;
87   void *stop_data[4];
88
89   /* output buffer, anything inside will be written to the peer as
90    * soon as possible */
91   struct autobuf out;
92
93   /*
94    * internal part of the server
95    */
96   struct list_node node;
97   int fd;
98   enum connection_state state;
99   enum http_header_type send_as;
100   struct timer_entry *timeout;
101   bool is_http;
102   struct autobuf in;
103 };
104
105 LISTNODE2STRUCT(comport_node2con, struct comport_connection, node);
106
107 void olsr_com_init(void);
108 void olsr_com_destroy(void);
109
110 void EXPORT(olsr_com_activate_output) (struct comport_connection *con);
111
112 #endif /* OLSR_COMPORT_H_ */