xref: /freebsd/usr.sbin/ngctl/ngctl.h (revision b3e7694832e81d7a904a10f525f8797b753bf0d3)
14cf49a43SJulian Elischer 
24cf49a43SJulian Elischer /*
34cf49a43SJulian Elischer  * ngctl.h
44cf49a43SJulian Elischer  *
54cf49a43SJulian Elischer  * Copyright (c) 1996-1999 Whistle Communications, Inc.
64cf49a43SJulian Elischer  * All rights reserved.
74cf49a43SJulian Elischer  *
84cf49a43SJulian Elischer  * Subject to the following obligations and disclaimer of warranty, use and
94cf49a43SJulian Elischer  * redistribution of this software, in source or object code forms, with or
104cf49a43SJulian Elischer  * without modifications are expressly permitted by Whistle Communications;
114cf49a43SJulian Elischer  * provided, however, that:
124cf49a43SJulian Elischer  * 1. Any and all reproductions of the source or object code must include the
134cf49a43SJulian Elischer  *    copyright notice above and the following disclaimer of warranties; and
144cf49a43SJulian Elischer  * 2. No rights are granted, in any manner or form, to use Whistle
154cf49a43SJulian Elischer  *    Communications, Inc. trademarks, including the mark "WHISTLE
164cf49a43SJulian Elischer  *    COMMUNICATIONS" on advertising, endorsements, or otherwise except as
174cf49a43SJulian Elischer  *    such appears in the above copyright notice or in the software.
184cf49a43SJulian Elischer  *
194cf49a43SJulian Elischer  * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
204cf49a43SJulian Elischer  * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
214cf49a43SJulian Elischer  * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
224cf49a43SJulian Elischer  * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
234cf49a43SJulian Elischer  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
244cf49a43SJulian Elischer  * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
254cf49a43SJulian Elischer  * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
264cf49a43SJulian Elischer  * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
274cf49a43SJulian Elischer  * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
284cf49a43SJulian Elischer  * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
294cf49a43SJulian Elischer  * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
304cf49a43SJulian Elischer  * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
314cf49a43SJulian Elischer  * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
324cf49a43SJulian Elischer  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
334cf49a43SJulian Elischer  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
344cf49a43SJulian Elischer  * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
354cf49a43SJulian Elischer  * OF SUCH DAMAGE.
364cf49a43SJulian Elischer  */
374cf49a43SJulian Elischer 
38f8307e12SArchie Cobbs #define MAX_CMD_ALIAS	8
39f8307e12SArchie Cobbs 
404cf49a43SJulian Elischer /* Command descriptors */
414cf49a43SJulian Elischer struct ngcmd {
42f8307e12SArchie Cobbs 	  int		(*func)(int ac, char **av);	/* command function */
43f8307e12SArchie Cobbs 	  const char	*cmd;				/* command usage */
44f8307e12SArchie Cobbs 	  const char	*desc;				/* description */
45f8307e12SArchie Cobbs 	  const char	*help;				/* help text */
46f8307e12SArchie Cobbs 	  const char	*aliases[MAX_CMD_ALIAS];	/* command aliases */
474cf49a43SJulian Elischer };
484cf49a43SJulian Elischer 
494cf49a43SJulian Elischer /* Command return values */
504cf49a43SJulian Elischer #define CMDRTN_OK		0
514cf49a43SJulian Elischer #define CMDRTN_USAGE		1
524cf49a43SJulian Elischer #define CMDRTN_ERROR		2
534cf49a43SJulian Elischer #define CMDRTN_QUIT		3
544cf49a43SJulian Elischer 
554cf49a43SJulian Elischer /* Available commands */
56ede53ee3SPoul-Henning Kamp extern const struct ngcmd config_cmd;
574cf49a43SJulian Elischer extern const struct ngcmd connect_cmd;
584cf49a43SJulian Elischer extern const struct ngcmd debug_cmd;
59bbd6d60aSBrian Feldman extern const struct ngcmd dot_cmd;
604cf49a43SJulian Elischer extern const struct ngcmd help_cmd;
614cf49a43SJulian Elischer extern const struct ngcmd list_cmd;
624cf49a43SJulian Elischer extern const struct ngcmd mkpeer_cmd;
63f8307e12SArchie Cobbs extern const struct ngcmd msg_cmd;
644cf49a43SJulian Elischer extern const struct ngcmd name_cmd;
654cf49a43SJulian Elischer extern const struct ngcmd read_cmd;
664cf49a43SJulian Elischer extern const struct ngcmd rmhook_cmd;
674cf49a43SJulian Elischer extern const struct ngcmd show_cmd;
684cf49a43SJulian Elischer extern const struct ngcmd shutdown_cmd;
694cf49a43SJulian Elischer extern const struct ngcmd status_cmd;
704cf49a43SJulian Elischer extern const struct ngcmd types_cmd;
71be44fce4SArchie Cobbs extern const struct ngcmd write_cmd;
724cf49a43SJulian Elischer extern const struct ngcmd quit_cmd;
734cf49a43SJulian Elischer 
744cf49a43SJulian Elischer /* Data and control sockets */
754cf49a43SJulian Elischer extern int	csock, dsock;
764cf49a43SJulian Elischer 
776ebb8ebbSArchie Cobbs /* Misc functions */
786ebb8ebbSArchie Cobbs extern void	MsgRead(void);
796ebb8ebbSArchie Cobbs extern void	DumpAscii(const u_char *buf, int len);
806ebb8ebbSArchie Cobbs 
81