/*
 ******************************************************************************
 *                     HEADER FILE
 *
 *     Document no: @(#) $Name: VXWORKS_ITER40_2019102207 $ $RCSfile: ipl2tp_cmd.h,v $ $Revision: 1.9 $
 *     $Source: /home/interpeak/CVSRoot/ipl2tp/include/ipl2tp_cmd.h,v $
 *     $Author: tneale $ $Date: 2010-06-04 18:01:11 $
 *     $State: Exp $ $Locker:  $
 *
 *     INTERPEAK_COPYRIGHT_STRING
 *     Design and implementation by Joel Hortelius <joel.hortelius@interpeak.se>
 ******************************************************************************
 */
#ifndef IPL2TP_CMD_H
#define IPL2TP_CMD_H

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

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

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

#ifdef __cplusplus
extern "C" {
#endif

/*
 ****************************************************************************
 * 4                    DEFINES
 ****************************************************************************
 */

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

/*
 ****************************************************************************
 * 6                    FUNCTIONS
 ****************************************************************************
 */
extern int ipl2tp_buffer_free;

/*
 ****************************************************************************
 *      PUBLIC FUNCTIONS
 ****************************************************************************
 */


/*
 *===========================================================================
 *                    ipl2tp_cmd_session_key
 *===========================================================================
 * Description: Find a session key based on ifindex
 * Parameters:  ifindex     - The interface index.
 * Returns:     
 *
 */
IP_EXTERN Ipl2tp_key  *ipl2tp_cmd_session_key(Ip_u32 ifindex);


/*
 *===========================================================================
 *                    ipl2tp_cmd_session_hash_add
 *===========================================================================
 * Description: Add an interface index - session ID pair to the hash table.
 * Parameters:  ifindex     - The interface index.
 *              skey        - pointer to key having session ID.
 * Returns:     None.
 *
 */
IP_EXTERN Ip_err ipl2tp_cmd_session_hash_add(Ip_u32 ifindex, Ipl2tp_key *skey);


/*
 *===========================================================================
 *                    ipl2tp_cmd_session_hash_remove
 *===========================================================================
 * Description: Remove an interface index - session ID pair from the hash table.
 * Parameters:  ifindex     - The interface index.
 *              skey        - pointer to key having session ID.
 * Returns:     None.
 *
 */
IP_EXTERN Ip_err ipl2tp_cmd_session_hash_remove(Ip_u32 ifindex);


/*
 *===========================================================================
 *                    ipl2tp_cmd_topen
 *===========================================================================
 * Description: Tunnel open command.
 * Parameters:  argc    - No of arguments.
 *              argv    - Argument vector.
 * Returns:     0 if success.
 *
 */
IP_EXTERN int ipl2tp_cmd_topen(int argc, char **argv);


/*
 *===========================================================================
 *                    ipl2tp_cmd_tclose
 *===========================================================================
 * Description: Tunnel close command.
 * Parameters:  argc    - No of arguments.
 *              argv    - Argument vector.
 * Returns:     0 if success.
 *
 */
IP_EXTERN int ipl2tp_cmd_tclose(int argc, char **argv);


/*
 *===========================================================================
 *                    ipl2tp_cmd_sopen
 *===========================================================================
 * Description: Session open command.
 * Parameters:  argc    - No of arguments.
 *              argv    - Argument vector.
 * Returns:     0 if success.
 *
 */
IP_EXTERN int ipl2tp_cmd_sopen(int argc, char **argv);


/*
 *===========================================================================
 *                    ipl2tp_cmd_sclose
 *===========================================================================
 * Description: Session close command.
 * Parameters:  argc    - No of arguments.
 *              argv    - Argument vector.
 * Returns:     0 if success.
 *
 */
IP_EXTERN int ipl2tp_cmd_sclose(int argc, char **argv);


/*
 *===========================================================================
 *                    ipl2tp_cmd_attr
 *===========================================================================
 * Description: Attribute command.
 * Parameters:  argc    - No of arguments.
 *              argv    - Argument vector.
 * Returns:     0 if success.
 *
 */
IP_EXTERN int ipl2tp_cmd_attr(int argc, char **argv);


/*
 *===========================================================================
 *                    ipl2tp_cmd_tattr
 *===========================================================================
 * Description: Tunnel attribute command.
 * Parameters:  argc    - No of arguments.
 *              argv    - Argument vector.
 * Returns:     0 if success.
 *
 */
IP_EXTERN int ipl2tp_cmd_tattr(int argc, char **argv);


/*
 *===========================================================================
 *                    ipl2tp_cmd_sattr
 *===========================================================================
 * Description: Session attribute command.
 * Parameters:  argc    - No of arguments.
 *              argv    - Argument vector.
 * Returns:     0 if success.
 *
 */
IP_EXTERN int ipl2tp_cmd_sattr(int argc, char **argv);


/*
 *===========================================================================
 *                    ipl2tp_cmd_stats
 *===========================================================================
 * Description: Statistics command.
 * Parameters:  argc    - No of arguments.
 *              argv    - Argument vector.
 * Returns:     0 if success.
 *
 */
IP_EXTERN int ipl2tp_cmd_stats(int argc, char **argv);


/*
 *===========================================================================
 *                    ipl2tp_cmd_tstats
 *===========================================================================
 * Description: Tunnel statistics command.
 * Parameters:  argc    - No of arguments.
 *              argv    - Argument vector.
 * Returns:     0 if success
 *
 */
IP_EXTERN int ipl2tp_cmd_tstats(int argc, char **argv);


/*
 *===========================================================================
 *                    ipl2tp_cmd_sstats
 *===========================================================================
 * Description: Session statistics command.
 * Parameters:  argc    - No of arguments.
 *              argv    - Argument vector.
 * Returns:     0 if success
 *
 */
IP_EXTERN int ipl2tp_cmd_sstats(int argc, char **argv);


/*
 *===========================================================================
 *                    ipl2tp_cmd_poke
 *===========================================================================
 * Description: Setup poke information for incoming messages.
 * Parameters:  argc    - No of arguments.
 *              argv    - Argument vector.
 * Returns:     0 if success.
 *
 */
IP_EXTERN int ipl2tp_cmd_poke(int argc, char **argv);


/*
 *===========================================================================
 *                    ipl2tp_cmd_main
 *===========================================================================
 * Description: Main L2TP command.
 * Parameters:  argc    - No of arguments.
 *              argv    - Argument vector.
 * Returns:     0 if success.
 *
 */
IP_EXTERN int ipl2tp_cmd_main(int argc, char **argv);


/*
 *===========================================================================
 *                    ipl2tp_cmdd
 *===========================================================================
 * Description: Init & socket daemon.
 * Parameters:  
 * Returns:     
 *
 */
IP_EXTERN void ipl2tp_cmdd(void);


#ifdef __cplusplus
}
#endif

#endif

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