Snapdragon® Telematics Application Framework (TelAF) Interface Specification
taf_someipDef_common.h File Reference
#include "legato.h"

Go to the source code of this file.

Macros

#define IFGEN_TAF_SOMEIPDEF_PROTOCOL_ID   "e9a41a30d57236e16b9e2880ae173546"
 
#define IFGEN_TAF_SOMEIPDEF_MSG_SIZE   9
 
#define TAF_SOMEIPDEF_MAX_IFNAME_LENGTH   32
 
#define TAF_SOMEIPDEF_MAX_PAYLOAD_SIZE   17408
 
#define TAF_SOMEIPDEF_DEFAULT_MAJOR   0
 
#define TAF_SOMEIPDEF_DEFAULT_MINOR   0
 
#define TAF_SOMEIPDEF_ANY_MAJOR   255
 
#define TAF_SOMEIPDEF_ANY_MINOR   4294967295
 
#define TAF_SOMEIPDEF_MT_REQUEST   0
 
#define TAF_SOMEIPDEF_MT_REQUEST_NO_RETURN   1
 
#define TAF_SOMEIPDEF_MT_NOTIFICATION   2
 
#define TAF_SOMEIPDEF_MT_RESPONSE   128
 
#define TAF_SOMEIPDEF_MT_ERROR   129
 
#define TAF_SOMEIPDEF_E_OK   0
 
#define TAF_SOMEIPDEF_E_NOT_OK   1
 
#define TAF_SOMEIPDEF_E_UNKNOWN_SERVICE   2
 
#define TAF_SOMEIPDEF_E_UNKNOWN_METHOD   3
 
#define TAF_SOMEIPDEF_E_NOT_READY   4
 
#define TAF_SOMEIPDEF_E_NOT_REACHABLE   5
 
#define TAF_SOMEIPDEF_E_TIMEOUT   6
 
#define TAF_SOMEIPDEF_E_WRONG_PROTOCOL_VERSION   7
 
#define TAF_SOMEIPDEF_E_WRONG_INTERFACE_VERSION   8
 
#define TAF_SOMEIPDEF_E_MALFORMED_MESSAGE   9
 
#define TAF_SOMEIPDEF_E_WRONG_MESSAGE_TYPE   10
 
#define TAF_SOMEIPDEF_EVENT_MASK   32768
 

Enumerations

enum  taf_someipDef_EventType_t { TAF_SOMEIPDEF_ET_EVENT = 0, TAF_SOMEIPDEF_ET_FIELD = 1 }
 

Functions

LE_SHARED bool ifgen_taf_someipDef_HasLocalBinding (void)
 
LE_SHARED void ifgen_taf_someipDef_InitCommonData (void)
 
LE_SHARED void ifgen_taf_someipDef_CleanupCommonData (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED le_result_t ifgen_taf_someipDef_OpenSession (le_msg_SessionRef_t _ifgen_sessionRef, bool isBlocking)
 

Macro Definition Documentation

◆ IFGEN_TAF_SOMEIPDEF_PROTOCOL_ID

#define IFGEN_TAF_SOMEIPDEF_PROTOCOL_ID   "e9a41a30d57236e16b9e2880ae173546"

◆ IFGEN_TAF_SOMEIPDEF_MSG_SIZE

#define IFGEN_TAF_SOMEIPDEF_MSG_SIZE   9

◆ TAF_SOMEIPDEF_MAX_IFNAME_LENGTH

#define TAF_SOMEIPDEF_MAX_IFNAME_LENGTH   32

The maximum length of network interface name.

◆ TAF_SOMEIPDEF_MAX_PAYLOAD_SIZE

#define TAF_SOMEIPDEF_MAX_PAYLOAD_SIZE   17408

The maximum size of the payload data in bytes.

◆ TAF_SOMEIPDEF_DEFAULT_MAJOR

#define TAF_SOMEIPDEF_DEFAULT_MAJOR   0

Define the default major version and minor version used by offering a service.

◆ TAF_SOMEIPDEF_DEFAULT_MINOR

#define TAF_SOMEIPDEF_DEFAULT_MINOR   0

◆ TAF_SOMEIPDEF_ANY_MAJOR

#define TAF_SOMEIPDEF_ANY_MAJOR   255

Define the any major version and minor version used by finding a service.

◆ TAF_SOMEIPDEF_ANY_MINOR

#define TAF_SOMEIPDEF_ANY_MINOR   4294967295

◆ TAF_SOMEIPDEF_MT_REQUEST

#define TAF_SOMEIPDEF_MT_REQUEST   0

Define the message type (as per the SOME/IP Protocol Specification).

◆ TAF_SOMEIPDEF_MT_REQUEST_NO_RETURN

#define TAF_SOMEIPDEF_MT_REQUEST_NO_RETURN   1

◆ TAF_SOMEIPDEF_MT_NOTIFICATION

#define TAF_SOMEIPDEF_MT_NOTIFICATION   2

◆ TAF_SOMEIPDEF_MT_RESPONSE

#define TAF_SOMEIPDEF_MT_RESPONSE   128

◆ TAF_SOMEIPDEF_MT_ERROR

#define TAF_SOMEIPDEF_MT_ERROR   129

◆ TAF_SOMEIPDEF_E_OK

#define TAF_SOMEIPDEF_E_OK   0

Define the return code (as per the SOME/IP Protocol Specification).

◆ TAF_SOMEIPDEF_E_NOT_OK

#define TAF_SOMEIPDEF_E_NOT_OK   1

◆ TAF_SOMEIPDEF_E_UNKNOWN_SERVICE

#define TAF_SOMEIPDEF_E_UNKNOWN_SERVICE   2

◆ TAF_SOMEIPDEF_E_UNKNOWN_METHOD

#define TAF_SOMEIPDEF_E_UNKNOWN_METHOD   3

◆ TAF_SOMEIPDEF_E_NOT_READY

#define TAF_SOMEIPDEF_E_NOT_READY   4

◆ TAF_SOMEIPDEF_E_NOT_REACHABLE

#define TAF_SOMEIPDEF_E_NOT_REACHABLE   5

◆ TAF_SOMEIPDEF_E_TIMEOUT

#define TAF_SOMEIPDEF_E_TIMEOUT   6

◆ TAF_SOMEIPDEF_E_WRONG_PROTOCOL_VERSION

#define TAF_SOMEIPDEF_E_WRONG_PROTOCOL_VERSION   7

◆ TAF_SOMEIPDEF_E_WRONG_INTERFACE_VERSION

#define TAF_SOMEIPDEF_E_WRONG_INTERFACE_VERSION   8

◆ TAF_SOMEIPDEF_E_MALFORMED_MESSAGE

#define TAF_SOMEIPDEF_E_MALFORMED_MESSAGE   9

◆ TAF_SOMEIPDEF_E_WRONG_MESSAGE_TYPE

#define TAF_SOMEIPDEF_E_WRONG_MESSAGE_TYPE   10

◆ TAF_SOMEIPDEF_EVENT_MASK

#define TAF_SOMEIPDEF_EVENT_MASK   32768

Define the special MACROs (as per the SOME/IP Protocol Specification).

Enumeration Type Documentation

◆ taf_someipDef_EventType_t

Event type enum

Enumerator
TAF_SOMEIPDEF_ET_EVENT 

The event represents an event notification.

TAF_SOMEIPDEF_ET_FIELD 

The event represents a field notification.

Function Documentation

◆ ifgen_taf_someipDef_HasLocalBinding()

LE_SHARED bool ifgen_taf_someipDef_HasLocalBinding ( void  )

Get if this client bound locally.

◆ ifgen_taf_someipDef_InitCommonData()

LE_SHARED void ifgen_taf_someipDef_InitCommonData ( void  )

Init data that is common across all threads

◆ ifgen_taf_someipDef_CleanupCommonData()

LE_SHARED void ifgen_taf_someipDef_CleanupCommonData ( le_msg_SessionRef_t  _ifgen_sessionRef)

Cleanup the data of a session

◆ ifgen_taf_someipDef_OpenSession()

LE_SHARED le_result_t ifgen_taf_someipDef_OpenSession ( le_msg_SessionRef_t  _ifgen_sessionRef,
bool  isBlocking 
)

Perform common initialization and open a session