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