taf_simSap_common.h File Reference

#include "legato.h"

Go to the source code of this file.

Macros
#define	IFGEN_TAF_SIMSAP_PROTOCOL_ID   "cd63ff7070f208d218753ccb8d4682b7"
#define	IFGEN_TAF_SIMSAP_MSG_SIZE   288
#define	TAF_SIMSAP_MAX_MSG_SIZE   276
#define	TAF_SIMSAP_MIN_MSG_SIZE   200

Typedefs
typedef struct taf_simSap_MessageHandler *	taf_simSap_MessageHandlerRef_t
typedef void(*	taf_simSap_MessageHandlerFunc_t) (const uint8_t *messagePtr, size_t messageSize, void *contextPtr)

Functions
LE_SHARED bool	ifgen_taf_simSap_HasLocalBinding (void)
LE_SHARED void	ifgen_taf_simSap_InitCommonData (void)
LE_SHARED void	ifgen_taf_simSap_CleanupCommonData (le_msg_SessionRef_t _ifgen_sessionRef)
LE_SHARED le_result_t	ifgen_taf_simSap_OpenSession (le_msg_SessionRef_t _ifgen_sessionRef, bool isBlocking)
LE_SHARED taf_simSap_MessageHandlerRef_t	ifgen_taf_simSap_AddMessageHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_simSap_MessageHandlerFunc_t handlerPtr, void *contextPtr)
LE_SHARED void	ifgen_taf_simSap_RemoveMessageHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_simSap_MessageHandlerRef_t handlerRef)
LE_SHARED le_result_t	ifgen_taf_simSap_SendMessage (le_msg_SessionRef_t _ifgen_sessionRef, const uint8_t *messagePtr, size_t messageSize)

Macro Definition Documentation

IFGEN_TAF_SIMSAP_PROTOCOL_ID

#define IFGEN_TAF_SIMSAP_PROTOCOL_ID   "cd63ff7070f208d218753ccb8d4682b7"

IFGEN_TAF_SIMSAP_MSG_SIZE

#define IFGEN_TAF_SIMSAP_MSG_SIZE   288

TAF_SIMSAP_MAX_MSG_SIZE

#define TAF_SIMSAP_MAX_MSG_SIZE   276

Maximum message size.

TAF_SIMSAP_MIN_MSG_SIZE

#define TAF_SIMSAP_MIN_MSG_SIZE   200

Minimum message size.

Typedef Documentation

taf_simSap_MessageHandlerRef_t

typedef struct taf_simSap_MessageHandler* taf_simSap_MessageHandlerRef_t

Reference type used by Add/Remove functions for EVENT 'taf_simSap_Message'

taf_simSap_MessageHandlerFunc_t

typedef void(* taf_simSap_MessageHandlerFunc_t) (const uint8_t *messagePtr, size_t messageSize, void *contextPtr)

Handler to get SAP response messages for specific requested messages from the subscibtion module.

Function Documentation

ifgen_taf_simSap_HasLocalBinding()

LE_SHARED bool ifgen_taf_simSap_HasLocalBinding

(

void

)

Get if this client bound locally.

ifgen_taf_simSap_InitCommonData()

LE_SHARED void ifgen_taf_simSap_InitCommonData

(

void

)

Init data that is common across all threads

ifgen_taf_simSap_CleanupCommonData()

LE_SHARED void ifgen_taf_simSap_CleanupCommonData

(

le_msg_SessionRef_t

_ifgen_sessionRef

)

Cleanup the data of a session

ifgen_taf_simSap_OpenSession()

LE_SHARED le_result_t ifgen_taf_simSap_OpenSession	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		bool	isBlocking
	)

Perform common initialization and open a session

ifgen_taf_simSap_AddMessageHandler()

LE_SHARED taf_simSap_MessageHandlerRef_t ifgen_taf_simSap_AddMessageHandler	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_simSap_MessageHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

Add handler function for EVENT 'taf_simSap_Message'

Event to notify and send a message.

Parameters

[in]	handlerPtr	Message handler.
[in]	contextPtr

ifgen_taf_simSap_RemoveMessageHandler()

LE_SHARED void ifgen_taf_simSap_RemoveMessageHandler	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_simSap_MessageHandlerRef_t	handlerRef
	)

Remove handler function for EVENT 'taf_simSap_Message'

Parameters

[in]

handlerRef

ifgen_taf_simSap_SendMessage()

LE_SHARED le_result_t ifgen_taf_simSap_SendMessage	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		const uint8_t *	messagePtr,
		size_t	messageSize
	)

Sends a message to the service which the sends it to the subscription module.

Returns

• LE_OK – Succeeded.
• LE_BAD_PARAMETER – Message is too long.

Parameters

[in]	messagePtr	The message.
[in]	messageSize