chiark / gitweb /
New manual page.
[fwd] / listener.h
1 /* -*-c-*-
2  *
3  * $Id: listener.h,v 1.1 1999/07/01 08:56:23 mdw Exp $
4  *
5  * A port forwarding listener
6  *
7  * (c) 1999 Mark Wooding
8  */
9
10 /*----- Licensing notice --------------------------------------------------* 
11  *
12  * This file is part of the `fw' port forwarder.
13  *
14  * `fw' is free software; you can redistribute it and/or modify
15  * it under the terms of the GNU General Public License as published by
16  * the Free Software Foundation; either version 2 of the License, or
17  * (at your option) any later version.
18  * 
19  * `fw' is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22  * GNU General Public License for more details.
23  * 
24  * You should have received a copy of the GNU General Public License
25  * along with `fw'; if not, write to the Free Software Foundation,
26  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
27  */
28
29 /*----- Revision history --------------------------------------------------* 
30  *
31  * $Log: listener.h,v $
32  * Revision 1.1  1999/07/01 08:56:23  mdw
33  * Initial revision
34  *
35  */
36
37 #ifndef LISTENER_H
38 #define LISTENER_H
39
40 #ifdef __cplusplus
41   extern "C" {
42 #endif
43
44 /*----- Header files ------------------------------------------------------*/
45
46 #include <stdio.h>
47
48 #include <sys/socket.h>
49 #include <netinet/in.h>
50
51 #include <mLib/sel.h>
52
53 #ifndef ACL_H
54 #  include "acl.h"
55 #endif
56
57 /*----- Data structures ---------------------------------------------------*/
58
59 /* --- A listener object --- */
60
61 typedef struct listener {
62   sel_file rd;                          /* Read selector for new connects */
63   struct sockaddr_in sin;               /* Destination address */
64   const char *desc;                     /* Description of forwarder */
65   acl_entry *acl;                       /* Access controls */
66 } listener;
67
68 /*----- Functions provided ------------------------------------------------*/
69
70 /* --- @listener_dump@ --- *
71  *
72  * Arguments:   @listener *l@ = pointer to listener block
73  *              @FILE *fp@ = stream to dump on
74  *
75  * Returns:     ---
76  *
77  * Use:         Dumps a listener to an output stream.
78  */
79
80 extern void listener_dump(listener */*l*/, FILE */*fp*/);
81
82 /* --- @listener_add@ --- *
83  *
84  * Arguments:   @int fd@ = created listening socket
85  *              @unsigned sp@ = source port number
86  *              @struct sockaddr_in *sin@ = pointer to destination address
87  *
88  * Returns:     The address of the new listener.
89  *
90  * Use:         Adds a forwarding listener.
91  */
92
93 extern listener *listener_add(int /*fd*/,
94                               unsigned /*sp*/, struct sockaddr_in */*sin*/);
95
96 /*----- That's all, folks -------------------------------------------------*/
97
98 #ifdef __cplusplus
99   }
100 #endif
101
102 #endif