chiark / gitweb /
docs: Generate grammar and option summaries from manpage.
[fwd] / socket.h
1 /* -*-c-*-
2  *
3  * $Id: socket.h,v 1.3 2004/04/08 01:36:25 mdw Exp $
4  *
5  * Socket source and target definitions
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 SOCKET_H
30 #define SOCKET_H
31
32 #ifdef __cplusplus
33   extern "C" {
34 #endif
35
36 /*----- Header files ------------------------------------------------------*/
37
38 #ifndef SOURCE_H
39 #  include "source.h"
40 #endif
41
42 #ifndef TARGET_H
43 #  include "target.h"
44 #endif
45
46 /*----- Sources and targets -----------------------------------------------*/
47
48 extern source_ops ssource_ops;
49 extern target_ops starget_ops;
50
51 /*----- Functions provided ------------------------------------------------*/
52
53 /* --- @starget_connected@ --- *
54  *
55  * Arguments:   @int fd@ = file descriptor now ready for use
56  *              @void *p@ = pointer to an endpoint structure
57  *
58  * Returns:     ---
59  *
60  * Use:         Handles successful connection of the target endpoint.
61  */
62
63 extern void starget_connected(int /*fd*/, void */*p*/);
64
65 /*----- That's all, folks -------------------------------------------------*/
66
67 #ifdef __cplusplus
68   }
69 #endif
70
71 #endif