sbgECom.h

Go to the documentation of this file.

#ifndef __SBG_ECOM_H__
#define __SBG_ECOM_H__

#ifdef __cplusplus
extern "C" {
#endif

#include <sbgCommon.h>
#include "sbgEComIds.h"
#include "protocol/sbgEComProtocol.h"
#include "binaryLogs/sbgEComBinaryLogs.h"

//----------------------------------------------------------------------//
//- Predefinitions                                                     -//
//----------------------------------------------------------------------//

typedef struct _SbgEComHandle SbgEComHandle;

//----------------------------------------------------------------------//
//- Callbacks definitions                                              -//
//----------------------------------------------------------------------//

typedef SbgErrorCode (*SbgEComReceiveFunc)(SbgEComHandle *pHandle, SbgEComCmdId logCmd, const SbgBinaryLogData *pLogData, void *pUserArg);

typedef SbgErrorCode (*SbgEComReceiveLogFunc)(SbgEComHandle *pHandle, SbgEComClass msgClass, SbgEComMsgId msg, const SbgBinaryLogData *pLogData, void *pUserArg);

//----------------------------------------------------------------------//
//- Structures definitions                                             -//
//----------------------------------------------------------------------//

struct _SbgEComHandle
{
        SbgEComProtocol                          protocolHandle;                        
        SbgEComReceiveFunc                       pReceiveCallback;                      
        SbgEComReceiveLogFunc            pReceiveLogCallback;           
        void                                            *pUserArg;                                      
        uint32                                           numTrials;                                     
        uint32                                           cmdDefaultTimeOut;                     
};

//----------------------------------------------------------------------//
//- Public methods declarations                                        -//
//----------------------------------------------------------------------//

SbgErrorCode sbgEComInit(SbgEComHandle *pHandle, SbgInterface *pInterface);

SbgErrorCode sbgEComClose(SbgEComHandle *pHandle);

SbgErrorCode sbgEComHandleOneLog(SbgEComHandle *pHandle);

SbgErrorCode sbgEComHandle(SbgEComHandle *pHandle);

SBG_DEPRECATED(SbgErrorCode sbgEComSetReceiveCallback(SbgEComHandle *pHandle, SbgEComReceiveFunc pReceiveCallback, void *pUserArg));

SbgErrorCode sbgEComSetReceiveLogCallback(SbgEComHandle *pHandle, SbgEComReceiveLogFunc pReceiveLogCallback, void *pUserArg);

void sbgEComSetCmdTrialsAndTimeOut(SbgEComHandle *pHandle, uint32 numTrials, uint32 cmdDefaultTimeOut);

uint32 sbgEComGetVersion(void);

const char *sbgEComGetVersionAsString(void);

void sbgEComErrorToString(SbgErrorCode errorCode, char errorMsg[256]);

//----------------------------------------------------------------------//
//- Footer (close extern C block)                                      -//
//----------------------------------------------------------------------//
#ifdef __cplusplus
}
#endif

#endif  /* __SBG_ECOM_H__ */