xref: /dragonfly/usr.sbin/ngctl/ngctl.h (revision 5de36205)
1 /*
2  * ngctl.h
3  *
4  * Copyright (c) 1996-1999 Whistle Communications, Inc.
5  * All rights reserved.
6  *
7  * Subject to the following obligations and disclaimer of warranty, use and
8  * redistribution of this software, in source or object code forms, with or
9  * without modifications are expressly permitted by Whistle Communications;
10  * provided, however, that:
11  * 1. Any and all reproductions of the source or object code must include the
12  *    copyright notice above and the following disclaimer of warranties; and
13  * 2. No rights are granted, in any manner or form, to use Whistle
14  *    Communications, Inc. trademarks, including the mark "WHISTLE
15  *    COMMUNICATIONS" on advertising, endorsements, or otherwise except as
16  *    such appears in the above copyright notice or in the software.
17  *
18  * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
19  * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
20  * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
21  * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
23  * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
24  * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
25  * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
26  * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
27  * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
28  * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
29  * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
30  * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
31  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
33  * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
34  * OF SUCH DAMAGE.
35  *
36  * $FreeBSD: src/usr.sbin/ngctl/ngctl.h,v 1.6.2.3 2002/02/01 18:17:43 archie Exp $
37  * $DragonFly: src/usr.sbin/ngctl/ngctl.h,v 1.4 2005/03/16 04:45:07 joerg Exp $
38  */
39 
40 #include <sys/types.h>
41 #include <sys/param.h>
42 #include <sys/time.h>
43 #include <sys/socket.h>
44 #include <sys/select.h>
45 
46 #include <stdio.h>
47 #include <stdlib.h>
48 #include <string.h>
49 #include <unistd.h>
50 #include <sysexits.h>
51 #include <limits.h>
52 #include <ctype.h>
53 #include <errno.h>
54 #include <err.h>
55 
56 #include <netgraph.h>
57 #include <netgraph/socket/ng_socket.h>
58 #include <netgraph/ng_message.h>
59 
60 #define MAX_CMD_ALIAS	8
61 
62 /* Command descriptors */
63 struct ngcmd {
64 	  int		(*func)(int ac, const char **av); /* command function */
65 	  const char	*cmd;				/* command usage */
66 	  const char	*desc;				/* description */
67 	  const char	*help;				/* help text */
68 	  const char	*aliases[MAX_CMD_ALIAS];	/* command aliases */
69 };
70 
71 /* Command return values */
72 #define CMDRTN_OK		0
73 #define CMDRTN_USAGE		1
74 #define CMDRTN_ERROR		2
75 #define CMDRTN_QUIT		3
76 
77 /* Available commands */
78 extern const struct ngcmd config_cmd;
79 extern const struct ngcmd connect_cmd;
80 extern const struct ngcmd debug_cmd;
81 extern const struct ngcmd help_cmd;
82 extern const struct ngcmd list_cmd;
83 extern const struct ngcmd mkpeer_cmd;
84 extern const struct ngcmd msg_cmd;
85 extern const struct ngcmd name_cmd;
86 extern const struct ngcmd read_cmd;
87 extern const struct ngcmd rmhook_cmd;
88 extern const struct ngcmd show_cmd;
89 extern const struct ngcmd shutdown_cmd;
90 extern const struct ngcmd status_cmd;
91 extern const struct ngcmd types_cmd;
92 extern const struct ngcmd write_cmd;
93 extern const struct ngcmd quit_cmd;
94 
95 /* Data and control sockets */
96 extern int	csock, dsock;
97 
98 /* Misc functions */
99 extern void	MsgRead(void);
100 extern void	DumpAscii(const u_char *buf, int len);
101