clRmdApi.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  : rmd
 * File        : clRmdApi.h
 *******************************************************************************/

/*******************************************************************************
 * Description :
 *          This header defines the RMD Interface.
 *
 *
 *****************************************************************************/

#ifndef _CL_RMD_API_H_
# define _CL_RMD_API_H_

# ifdef __cplusplus
extern "C"
{
# endif


/*****************************************************************************/


# include <clBufferApi.h>
# include <clIocApi.h>
# include <clRmdErrors.h>


    /*
     * RMD Flags
     */

# define CL_RMD_CALL_ASYNC               (1<<0)

# define CL_RMD_CALL_NEED_REPLY          (1<<1)

# define CL_RMD_CALL_ATMOST_ONCE         (1<<2)

# define CL_RMD_CALL_DO_NOT_OPTIMIZE     (1<<3)

# define CL_RMD_CALL_NON_PERSISTENT      (1<<4)

# define CL_RMD_CALL_IN_SESSION          (1<<5)

    /*
     * Default Values
     */

/*
 * Default header version of the RMD.
 */
#define CL_RMD_HEADER_VERSION     1

# define CL_RMD_DEFAULT_PRIORITY   CL_IOC_DEFAULT_PRIORITY

#ifdef QNX_BUILD

# define CL_RMD_DEFAULT_TIMEOUT    50000

#else

# define CL_RMD_DEFAULT_TIMEOUT    10000

#endif

# define CL_RMD_DEFAULT_RETRIES    5

# define CL_RMD_DEFAULT_TRANSPORT_HANDLE  0

#define CL_RMD_DEFAULT_OPTIONS { \
                                    CL_RMD_DEFAULT_TIMEOUT, \
                                    CL_RMD_DEFAULT_RETRIES, \
                                    CL_RMD_DEFAULT_PRIORITY,  \
                                    CL_RMD_DEFAULT_TRANSPORT_HANDLE, \
                               }

#define CL_RMD_DEFAULT_OPTIONS_SET(options) \
        (options).timeout = CL_RMD_DEFAULT_TIMEOUT, \
        (options).retries = CL_RMD_DEFAULT_RETRIES, \
        (options).priority = CL_RMD_DEFAULT_PRIORITY, \
        (options).transportHandle = CL_RMD_DEFAULT_LINK_HANDLE

# define CL_RMD_TIMEOUT_FOREVER    -1

/*
 * Check for typical rmd unreachable errors
 */
#define CL_RMD_UNREACHABLE_CHECK(ret)                           \
    (CL_GET_ERROR_CODE((ret)) == CL_IOC_ERR_COMP_UNREACHABLE || \
     CL_GET_ERROR_CODE((ret)) == CL_IOC_ERR_HOST_UNREACHABLE)

#define CL_RMD_TIMEOUT_UNREACHABLE_CHECK(ret)                           \
    ( CL_GET_ERROR_CODE((ret))== CL_ERR_TIMEOUT || CL_RMD_UNREACHABLE_CHECK(ret) ) 

#define CL_RMD_VERSION_ERROR(rc)  ( (rc) == CL_RC(CL_CID_EO, CL_ERR_DOESNT_EXIST) \
                                    || (rc) == CL_RC(CL_CID_EO, CL_ERR_VERSION_MISMATCH) )
        
/*
 * Type definitions
 */


    typedef void (*ClRmdAsyncCallbackT) (
                                            ClRcT retCode,
                                            ClPtrT pCookie,
                                            ClBufferHandleT inMsgHdl,
                                            ClBufferHandleT outMsgHdl);


    typedef ClPtrT ClRmdObjHandleT;

    typedef struct ClRmdOptions
    {

        ClUint32T timeout;

        ClUint32T retries;

        ClUint8T priority;

        ClIocToBindHandleT transportHandle;

    } ClRmdOptionsT;

    typedef struct ClRmdAsyncOptions
    {
        ClPtrT pCookie;
        ClRmdAsyncCallbackT fpCallback;

    } ClRmdAsyncOptionsT;



    ClRcT clRmdWithMsg(CL_IN ClIocAddressT remoteObjAddr,   /* remote Object
                                                             * addr */
                       CL_IN ClUint32T funcId,  /* Function ID to invoke */
                       CL_IN ClBufferHandleT inMsgHdl,   /* Input
                                                                 * Message */
                       CL_OUT ClBufferHandleT outMsgHdl, /* Output
                                                                 * Message */
                       CL_IN ClUint32T flags,   /* Flags */
                       CL_IN ClRmdOptionsT *pOptions,   /* Optional Parameters
                                                         * for RMD Call */
                       CL_IN ClRmdAsyncOptionsT *pAsyncOptions);    /* Optional
                                                                     * Parameters
                                                                     * for
                                                                     * Async
                                                                     * RMD Call
                                                                     */
 

    ClRcT clRmdWithMsgVer(CL_IN ClIocAddressT remoteObjAddr,   /* remote Object
                                                             * addr */
                          CL_IN ClVersionT *version,
                          CL_IN ClUint32T funcId,  /* Function ID to invoke */
                          CL_IN ClBufferHandleT inMsgHdl,   /* Input
                                                                 * Message */
                          CL_OUT ClBufferHandleT outMsgHdl, /* Output
                                                                 * Message */
                          CL_IN ClUint32T flags,   /* Flags */
                          CL_IN ClRmdOptionsT *pOptions,   /* Optional Parameters
                                                         * for RMD Call */
                          CL_IN ClRmdAsyncOptionsT *pAsyncOptions);    /* Optional
                                                                     * Parameters
                                                                     * for
                                                                     * Async
                                                                     * RMD Call
                                                                     */



# ifdef __cplusplus
}
# endif


#endif                          /* _CL_RMD_API_H_ */