/* ipdiameter_pagent.h - Diameter proxy agent header file */

/*
 * Copyright (c) 2007 Wind River Systems, Inc.
 *
 * The right to copy, distribute or otherwise make use of this software
 * may be licensed only pursuant to the terms of an applicable Wind River
 * license agreement. No license to Wind River intellectual property rights
 * is granted herein. All rights not licensed by Wind River are reserved
 * by Wind River.
 */

/*
modification history
--------------------
01c,12nov07,tlu  Add open() function for proxy agent
01b,09nov07,tlu  Remove unnecessary APIs
01a,16jul07,cwu  Created.
*/

#ifndef IPDIAMETER_PAGENT_H
#define IPDIAMETER_PAGENT_H

/*
 ****************************************************************************
 *                      DESCRIPTION
 ****************************************************************************
 *  Header file for Diameter proxy agent
 */

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

#include <ipcom_type.h>

#include "ipdiameter.h"




/*
 ****************************************************************************
 *                      Application APIs 
 ****************************************************************************
 */


#ifdef __cplusplus
extern "C" {
#endif

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

/*
 *===========================================================================
 *                    ipdiameterp_create
 *===========================================================================
 * Description:   Initialize IPDIAMETER proxy agent global data 'ipdiameter'
 * Parameters:    .
 * Returns:       IPCOM_SUCCESS or error code.
 *
 */
IP_PUBLIC Ip_err ipdiameterp_create(void);


/*
 *===========================================================================
 *                    ipdiameterp_exit
 *===========================================================================
 * Description:   Release, i.e. free, temporary IPDIAMETER dynamic memory.
 * Parameters:    .
 * Returns:       .
 *
 */
IP_PUBLIC Ip_err ipdiameterp_exit(void);


/*
 *===========================================================================
 *                    ipdiameterp_close
 *===========================================================================
 * Description:   Close an opened IPDIAMETER. 
 * Parameters:    .
 * Returns:       IPCOM_ERR_ALREADY_CLOSED - Failed to close since not open.
 *                IPCOM_SUCCESS - Success.
 *
 */
IP_PUBLIC Ip_err ipdiameterp_close(void);


/*
 *===========================================================================
 *                    ipdiameterp_open
 *===========================================================================
 * Description:   Open IPDIAMETER proxy agent: read in proxy agent specific
 *                configuration parameters.
 * Parameters:    .
 * Returns:       IPCOM_ERR_INVALID_CONFIG - invalid config parameters.
 *                IPCOM_SUCCESS - Success.
 *
 */
IP_PUBLIC Ip_err ipdiameterp_open(void);


/*
 *===========================================================================
 *                    ipdiameterp_start
 *===========================================================================
 * Description:   Start IPDIAMETER daemon.
 * Parameters:    .
 * Returns:       IPCOM_ERR_ALREADY_CLOSED - Failed to start the daemon.
 *                IPCOM_SUCCESS - Success.
 *
 */
IP_PUBLIC Ip_err ipdiameterp_start(void);


/*
 *===========================================================================
 *                    ipdiameterp_stop
 *===========================================================================
 * Description:   Stop IPDIAMETER daemon.
 * Parameters:    .
 * Returns:       IPCOM_ERR_NOT_STARTED - Failed to stop the daemon.
 *                IPCOM_SUCCESS - Success.
 *
 */
IP_PUBLIC Ip_err ipdiameterp_stop(void);

#ifdef __cplusplus
}
#endif


#endif /*#ifndef IPDIAMETER_PAGENT_H*/

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