/* ipmippm_if.h - ipmippm_if.h */
/*
 ******************************************************************************
 *                     HEADER FILE
 *
 *     Document no: @(#) $Name: VXWORKS_ITER40_2019102207 $ $RCSfile: ipmippm_if.h,v $ $Revision: 1.1 $
 *     $Source: /home/interpeak/CVSRoot/ipmippm/src/ipmippm_if.h,v $
 *     $Author: jhorteli $ $Date: 2009-04-23 15:19:27 $
 *     $State: Exp $ $Locker:  $
 *
 *     INTERPEAK_COPYRIGHT_STRING
 *     Design and implementation by Joel Hortelius <joel.hortelius@interpeak.se>
 ******************************************************************************
 */
#ifndef IPMIPPM_IFF_H
#define IPMIPPM_IFF_H

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

 No description currently provided
*/

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

/*
 ****************************************************************************
 * 3                    INCLUDE FILES
 ****************************************************************************
 */
#include <private/ipmip4_if.h>

#ifdef __cplusplus
extern "C" {
#endif

/*
 ****************************************************************************
 * 4                    DEFINES
 ****************************************************************************
 */
/*
 ****************************************************************************
 * 5                    TYPES
 ****************************************************************************
 */
struct Ipmippm_context;
struct Ipmippm_client_conf;
struct Ipmip_proc;

/* one per interface */
typedef struct Ipmipmn_api_iff
{
    Ipmip4_if_t                 iff;

    Ipmip_timer_lock_t         *if_lock;

    /* Client lookup structures */
    Ipcom_mutex                client_lock;
    Ipcom_hash                 *hash_nai;      /* All known MN using NAI address as key       */

    /**/
    struct Ipmippm_client_conf *conf;
}
Ipmippm_if_t;

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

/*******************************************************************************
*
* ipmippm_if_create - ipmippm_if_create
*
* Create an interface for a specified configuration.
*
* Parameters:
* \is
* \i data
* The FA entity.
* \i proc
* Current process.
* \i conf
* The current configuration.
* \i ifname
* The name of the interface.
* \ie
*
* RETURNS: IP_TRUE if successful.
*
* ERRNO:
*
* \NOMANUAL
*/
IP_GLOBAL Ip_bool  ipmippm_if_create
(
    struct Ipmippm_context  *data,
    struct Ipmip_proc       *proc,
    struct Ipmippm_conf     *conf,
    const char              *ifname
);


/*******************************************************************************
*
* ipmippm_if_stop - ipmippm_if_stop
*
* Stop the interfaces belonging to a particular configuration
*
* Parameters:
* \is
* \i data
* The FA entity.
* \i proc
* Current process
* \i conf
* The current configuration.
* \ie
*
* RETURNS: No return value
*
* ERRNO:
*
* \NOMANUAL
*/
IP_GLOBAL void  ipmippm_if_stop
(
    struct Ipmippm_context  *data,
    struct Ipmip_proc       *proc,
    struct Ipmippm_conf     *conf
);

#ifdef __cplusplus
}
#endif

#endif

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