/* ipmip6_cli.h - ipmip6_cli.h */
/*
 ******************************************************************************
 *                     HEADER FILE
 *
 *     Document no: @(#) $Name: VXWORKS_ITER40_2019102207 $ $RCSfile: ipmip6_cli.h,v $ $Revision: 1.7 $
 *     $Source: /home/interpeak/CVSRoot/ipmip6/include/private/ipmip6_cli.h,v $
 *     $Author: jhorteli $ $Date: 2010-12-07 09:55:18 $
 *     $State: Exp $ $Locker:  $
 *
 *     INTERPEAK_COPYRIGHT_STRING
 *     Design and implementation by Joel Hortelius <joel.hortelius@interpeak.se>
 ******************************************************************************
 */
#ifndef IPMIP6_CLI_H
#define IPMIP6_CLI_H

/*
 ****************************************************************************
 * 1                    DESCRIPTION
 ****************************************************************************
 */

/*
 DESCRIPTION

 MIP6 CLI functions required for mobile IPv6. Deals with Command Line Interface
 communication with MIPv6. 

 The functions defined herein provides generic MIP6 CLI functionality. That is,
 they use the generic functionality provided by ipmip6_attr_command in
 ipmip6_attr.h.

 When creating a MIP6 shell command, and that shell command receives input
 which does not match any of the defined functions, one may invoke
 the functions defined in here in order to see if it is a MIP6 generic
 command.
*/

/*
 ****************************************************************************
 * 2                    CONFIGURATION
 ****************************************************************************
 */

/*
 ****************************************************************************
 * 3                    INCLUDE FILES
 ****************************************************************************
 */

#include <private/ipmip_cli.h>
#include <private/ipmip6_attr.h>

#ifdef __cplusplus
extern "C" {
#endif

/*
 ****************************************************************************
 * 4                    DEFINES
 ****************************************************************************
 */
enum
{
    IPMIP6_CLI_BASE         = 2048
};

/*
 ****************************************************************************
 * 5                    TYPES
 ****************************************************************************
 */

struct Ipmip_proc;
struct Ipmip_cli_daemon;

/*
 ****************************************************************************
 * 6                    FUNCTIONS
 ****************************************************************************
 */

/*******************************************************************************
*
* ipmip6_cli_shell_cmd - ipmip6_cli_shell_cmd
*
* Process global CLI commands
*
* Parameters:
* \is
* \i cmd
* Command
* \i argc
* Number of arguments
* \i argv
* Arguments
* \i proc
* The process context associated with the currently executing thread. Each
* thread and/or process in MIP must have its own unique process context.
* If a process is started using ipmip_proc_start, the process context will
* be allocated automatically by the IPMIP framework. Otherwise it must
* be allocated using ipmip_proc_alloc().
* \i daemon
* Daemon connection
* \ie
*
* RETURNS: > 0 syntax error, 0 = success
*
* ERRNO:
*
*/
IP_GLOBAL int ipmip6_cli_shell_cmd
(
    int                      argc, 
    char                     **argv,     
    struct Ipmip_proc        *proc,
    struct Ipmip_cli_daemon  *daemon
);

/*******************************************************************************
*
* ipmip6_cli_shell_usage - ipmip6_cli_shell_usage
*
* Print usage informatin for MIP6 related commands
*
* Parameters:
* \is
* \i proc
* The process context associated with the currently executing thread. Each
* thread and/or process in MIP must have its own unique process context.
* If a process is started using ipmip_proc_start, the process context will
* be allocated automatically by the IPMIP framework. Otherwise it must
* be allocated using ipmip_proc_alloc().
* \ie
*
* RETURNS: No return value
*
* ERRNO:
*
*/
IP_GLOBAL void ipmip6_cli_shell_usage
(
    struct Ipmip_proc        *proc
);


#ifdef __cplusplus
}
#endif

#endif

/*
 ****************************************************************************
 *                      END OF FILE
 ****************************************************************************
 */