chiark / gitweb /
New manual page.
[fwd] / forward.h
1 /* -*-c-*-
2  *
3  * $Id: forward.h,v 1.1 1999/07/01 08:56:23 mdw Exp $
4  *
5  * Port forwarding
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: forward.h,v $
32  * Revision 1.1  1999/07/01 08:56:23  mdw
33  * Initial revision
34  *
35  */
36
37 #ifndef FORWARD_H
38 #define FORWARD_H
39
40 #ifdef __cplusplus
41   extern "C" {
42 #endif
43
44 /*----- Header files ------------------------------------------------------*/
45
46 #include <sys/socket.h>
47 #include <netinet/in.h>
48
49 #ifndef IDENTIFY_H
50 #  include "identify.h"
51 #endif
52
53 /*----- Functions provided ------------------------------------------------*/
54
55 /* --- @forward@ --- *
56  *
57  * Arguments:   @int fd@ = file descriptor attached to client
58  *              @struct sockaddr_in *sin@ = pointer to destination address
59  *              @const id_req *q@ = pointer to identification request block
60  *
61  * Returns:     ---
62  *
63  * Use:         Start a port forwarding job.
64  */
65
66 extern void forward(int /*fd*/, struct sockaddr_in */*sin*/,
67                     const id_req */*q*/);
68
69 /*----- That's all, folks -------------------------------------------------*/
70
71 #ifdef __cplusplus
72   }
73 #endif
74
75 #endif