clIocApiExt.h

Go to the documentation of this file.

/*
 * Copyright (C) 2002-2012 OpenClovis Solutions Inc.  All Rights Reserved.
 *
 * This file is available  under  a  commercial  license  from  the
 * copyright  holder or the GNU General Public License Version 2.0.
 * 
 * The source code for  this program is not published  or otherwise 
 * divested of  its trade secrets, irrespective  of  what  has been 
 * deposited with the U.S. Copyright office.
 * 
 * This program is distributed in the  hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied  warranty  of 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 
 * General Public License for more details.
 * 
 * For more  information, see  the file  COPYING provided with this
 * material.
 */
/*******************************************************************************
 * ModuleName  : ioc                                                           
 * File        : clIocApiExt.h
 *******************************************************************************/

/*******************************************************************************
 * Description :                                                                
 *
 * This is the interface to extended API supported by IOC.
 *
 *
 *****************************************************************************/

#ifndef _CL_IOC_ASP_INTERNAL_H_
# define _CL_IOC_ASP_INTERNAL_H_

# ifdef __cplusplus
extern "C"
{
# endif

#include <clIocApi.h>
    
    /*
     * Send related Flags 
     */
# define CL_IOC_NO_SESSION 0

# define CL_IOC_SESSION_BASED (1<<0)



    typedef enum ClIocNotificationId
    {
        CL_IOC_NODE_ARRIVAL_NOTIFICATION,
        CL_IOC_NODE_LEAVE_NOTIFICATION,
        CL_IOC_COMP_ARRIVAL_NOTIFICATION,
        CL_IOC_COMP_DEATH_NOTIFICATION,
        CL_IOC_SENDQ_WM_NOTIFICATION,
        CL_IOC_COMM_PORT_WM_NOTIFICATION,
        CL_IOC_LOG_NOTIFICATION,
        CL_IOC_NODE_VERSION_NOTIFICATION,
        CL_IOC_NODE_VERSION_REPLY_NOTIFICATION,
        CL_IOC_NODE_DISCOVER_NOTIFICATION,
        CL_IOC_NODE_LINK_UP_NOTIFICATION,    
        CL_IOC_NODE_LINK_DOWN_NOTIFICATION,
    } ClIocNotificationIdT;
    
    typedef struct ClIocQueueNotification
    {
        ClWaterMarkIdT wmID;
        ClWaterMarkT wm;
        ClUint32T queueSize;
        ClUint32T messageLength;
    } ClIocQueueNotificationT;

    typedef struct ClIocNotification
    {
        /*Notification ID*/
        ClIocNotificationIdT id;
        ClUint32T protoVersion;
        ClIocAddressT nodeAddress;
        ClUint32T nodeVersion;
        union  
        {
            /*
             * Node address and comp death would just need
             * node address  
            */
            struct sendqWMNotification
            {
                ClIocQueueNotificationT queueNotification;
            } sendqWMNotification;

            struct commPortWMNotification
            {
                ClIocQueueNotificationT queueNotification;
            } commPortWMNotification;

        } notificationData;

        #define sendqWMNotification    notificationData.sendqWMNotification.queueNotification
        #define commPortWMNotification notificationData.commPortWMNotification.queueNotification

    } ClIocNotificationT;


    ClRcT clIocMaxPayloadSizeGet(
    CL_OUT ClUint32T * pSize
    );



    ClRcT clIocTotalNeighborEntryGet(
    CL_OUT ClUint32T * pNumberOfEntries
    );



    ClRcT clIocNeighborListGet(
    CL_INOUT ClUint32T * pNumberOfEntries,
    CL_OUT ClIocNodeAddressT * pAddrList
    );



    ClRcT clIocLibInitialize(
            ClPtrT pConfig
            );




    ClRcT clIocLibFinalize(
    void
    );



    ClRcT clIocCommPortDebug(CL_IN ClIocPortT portId, CL_IN ClCharT *pCommand) CL_DEPRECATED;

    ClRcT clIocGeographicalAddressGet(
    CL_IN ClIocNodeAddressT iocNodeAddr,
    CL_OUT ClCharT * pGeoAddr
    ) CL_DEPRECATED;

    ClRcT clIocGeographicalAddressSet(
    CL_IN ClIocNodeAddressT iocNodeAddr,
    CL_IN ClCharT * pGeoAddr
    ) CL_DEPRECATED;

    ClRcT clIocSessionReset(
    CL_IN ClIocCommPortHandleT iocCommPortHdl,
    CL_IN ClIocLogicalAddressT * pIocLogicalAddress
    ) CL_DEPRECATED;

    ClRcT clIocBind(
    CL_IN ClNameT * toName,
    CL_OUT ClIocToBindHandleT * pToHandle
    ) CL_DEPRECATED;


# ifdef __cplusplus
}
# endif

#endif                          /* _CL_IOC_ASP_INTERNAL_H_ */