sbgECom.h

Go to the documentation of this file.

 
#ifndef SBG_ECOM_H
#define SBG_ECOM_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
// sbgCommonLib headers
#include <sbgCommon.h>
#include <interfaces/sbgInterface.h>
 
// Local headers
#include "sbgECanId.h"
#include "sbgEComIds.h"
#include "logs/sbgEComLog.h"
#include "protocol/sbgEComProtocol.h"
 
//----------------------------------------------------------------------//
//- Predefinitions                                                     -//
//----------------------------------------------------------------------//

typedef struct _SbgEComHandle SbgEComHandle;
 
//----------------------------------------------------------------------//
//- Callbacks definitions                                              -//
//----------------------------------------------------------------------//

typedef SbgErrorCode (*SbgEComReceiveLogFunc)(SbgEComHandle *pHandle, SbgEComClass msgClass, SbgEComMsgId msg, const SbgEComLogUnion *pLogData, void *pUserArg);
 
//----------------------------------------------------------------------//
//- Structures definitions                                             -//
//----------------------------------------------------------------------//

struct _SbgEComHandle
{
    SbgEComProtocol               protocolHandle;          
 
    SbgEComReceiveLogFunc       pReceiveLogCallback;        
    void                        *pUserArg;                  
 
    uint32_t                     numTrials;                    
    uint32_t                     cmdDefaultTimeOut;            
};
 
//----------------------------------------------------------------------//
//- Public methods                                                     -//
//----------------------------------------------------------------------//

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

SbgErrorCode sbgEComClose(SbgEComHandle *pHandle);

SbgErrorCode sbgEComHandleOneLog(SbgEComHandle *pHandle);

SbgErrorCode sbgEComHandle(SbgEComHandle *pHandle);

SbgErrorCode sbgEComPurgeIncoming(SbgEComHandle *pHandle);

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

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

void sbgEComErrorToString(SbgErrorCode errorCode, char errorMsg[256]);
 
#ifdef __cplusplus
}
#endif
 
#endif  // SBG_ECOM_H