usr.sbin/ngctl/ngctl.h

   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$
  38  */
  39
  40 #define MAX_CMD_ALIAS   8
  41
  42 /* Command descriptors */
  43 struct ngcmd {
  44           int           (*func)(int ac, char **av);     /* command function */
  45           const char    *cmd;                           /* command usage */
  46           const char    *desc;                          /* description */
  47           const char    *help;                          /* help text */
  48           const char    *aliases[MAX_CMD_ALIAS];        /* command aliases */
  49 };
  50
  51 /* Command return values */
  52 #define CMDRTN_OK               0
  53 #define CMDRTN_USAGE            1
  54 #define CMDRTN_ERROR            2
  55 #define CMDRTN_QUIT             3
  56
  57 /* Available commands */
  58 extern const struct ngcmd config_cmd;
  59 extern const struct ngcmd connect_cmd;
  60 extern const struct ngcmd debug_cmd;
  61 extern const struct ngcmd dot_cmd;
  62 extern const struct ngcmd help_cmd;
  63 extern const struct ngcmd list_cmd;
  64 extern const struct ngcmd mkpeer_cmd;
  65 extern const struct ngcmd msg_cmd;
  66 extern const struct ngcmd name_cmd;
  67 extern const struct ngcmd read_cmd;
  68 extern const struct ngcmd rmhook_cmd;
  69 extern const struct ngcmd show_cmd;
  70 extern const struct ngcmd shutdown_cmd;
  71 extern const struct ngcmd status_cmd;
  72 extern const struct ngcmd types_cmd;
  73 extern const struct ngcmd write_cmd;
  74 extern const struct ngcmd quit_cmd;
  75
  76 /* Data and control sockets */
  77 extern int      csock, dsock;
  78
  79 /* Misc functions */
  80 extern void     MsgRead(void);
  81 extern void     DumpAscii(const u_char *buf, int len);
  82