chiark / gitweb /
docs: Generate grammar and option summaries from manpage.
[fwd] / identify.h
1 /* -*-c-*-
2  *
3  * $Id: identify.h,v 1.4 2004/04/08 01:36:25 mdw Exp $
4  *
5  * Identifies and logs the client of a connection
6  *
7  * (c) 1999 Straylight/Edgeware
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 #ifndef IDENTIFY_H
30 #define IDENTIFY_H
31
32 #ifdef __cplusplus
33   extern "C" {
34 #endif
35
36 /*----- Header files ------------------------------------------------------*/
37
38 #include <sys/types.h>
39 #include <sys/socket.h>
40 #include <netinet/in.h>
41
42 #ifndef REFFD_H
43 #  include "reffd.h"
44 #endif
45
46 /*----- Data structures ---------------------------------------------------*/
47
48 typedef struct id_req {
49   struct sockaddr_in lsin;              /* Local address of connection */
50   struct sockaddr_in rsin;              /* Remote address of connection */
51   const char *desc;                     /* Description of connection */
52   const char *act;                      /* Action taken by server */
53   reffd *r;                             /* Pointer to file descriptor */
54 } id_req;
55
56 /*----- Functions provided ------------------------------------------------*/
57
58 /* --- @identify@ --- *
59  *
60  * Arguments:   @const id_req *q@ = pointer to request block
61  *
62  * Returns:     ---
63  *
64  * Use:         Starts a background ident lookup and reverse-resolve job
65  *              which will, eventually, report a message to the system log.
66  */
67
68 extern void identify(const id_req */*q*/);
69
70 /*----- That's all, folks -------------------------------------------------*/
71
72 #ifdef __cplusplus
73   }
74 #endif
75
76 #endif