taf_simRsim_interface.h File Reference

#include "legato.h"
#include "taf_simRsim_common.h"

Go to the source code of this file.

Typedefs
typedef void(*	taf_simRsim_DisconnectHandler_t) (void *)

Functions
void	taf_simRsim_ConnectService (void)
le_result_t	taf_simRsim_TryConnectService (void)
LE_FULL_API void	taf_simRsim_SetServerDisconnectHandler (taf_simRsim_DisconnectHandler_t disconnectHandler, void *contextPtr)
LE_FULL_API void	taf_simRsim_SetNonExitServerDisconnectHandler (taf_simRsim_DisconnectHandler_t disconnectHandler, void *contextPtr)
void	taf_simRsim_DisconnectService (void)
taf_simRsim_MessageHandlerRef_t	taf_simRsim_AddMessageHandler (taf_simRsim_MessageHandlerFunc_t handlerPtr, void *contextPtr)
void	taf_simRsim_RemoveMessageHandler (taf_simRsim_MessageHandlerRef_t handlerRef)
le_result_t	taf_simRsim_SendMessage (const uint8_t *messagePtr, size_t messageSize, taf_simRsim_CallbackHandlerFunc_t callbackPtr, void *contextPtr)

Typedef Documentation

taf_simRsim_DisconnectHandler_t

typedef void(* taf_simRsim_DisconnectHandler_t) (void *)

Type for handler called when a server disconnects.

Function Documentation

taf_simRsim_ConnectService()

void taf_simRsim_ConnectService

(

void

)

Connect the current client thread to the service providing this API. Block until the service is available.

For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see apiFilesC_client.

This function is created automatically.

taf_simRsim_TryConnectService()

le_result_t taf_simRsim_TryConnectService

(

void

)

Try to connect the current client thread to the service providing this API. Return with an error if the service is not available.

For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see apiFilesC_client.

This function is created automatically.

Returns

• LE_OK if the client connected successfully to the service.
• LE_UNAVAILABLE if the server is not currently offering the service to which the client is bound.
• LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
• LE_COMM_ERROR if the Service Directory cannot be reached.

taf_simRsim_SetServerDisconnectHandler()

LE_FULL_API void taf_simRsim_SetServerDisconnectHandler	(	taf_simRsim_DisconnectHandler_t	disconnectHandler,
		void *	contextPtr
	)

Set handler called when server disconnection is detected.

When a server connection is lost, call this handler then exit with LE_FATAL. If a program wants to continue without exiting, it should call longjmp() from inside the handler.

taf_simRsim_SetNonExitServerDisconnectHandler()

LE_FULL_API void taf_simRsim_SetNonExitServerDisconnectHandler	(	taf_simRsim_DisconnectHandler_t	disconnectHandler,
		void *	contextPtr
	)

Set handler called when server disconnection is detected without exiting.

When a server connection is lost, call this handler without exit.

Warning

When using the API, it needs the application developer to handle some cases like re-connecting and recycling the resources. For most of cases, it is safe to use SetServerDisconnectHandler.

taf_simRsim_DisconnectService()

void taf_simRsim_DisconnectService

(

void

)

Disconnect the current client thread from the service providing this API.

Normally, this function doesn't need to be called. After this function is called, there's no longer a connection to the service, and the functions in this API can't be used. For details, see apiFilesC_client.

This function is created automatically.

taf_simRsim_AddMessageHandler()

taf_simRsim_MessageHandlerRef_t taf_simRsim_AddMessageHandler	(	taf_simRsim_MessageHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

Handler to get notifications for specific messages when there are updates from the modem. Callback to get send message result. Reference type used by Add/Remove functions for EVENT 'taf_simRsim_Message' Add handler function for EVENT 'taf_simRsim_Message'

Event to notify and send a message.

Add handler function for EVENT 'taf_simRsim_Message'

Event to notify and send a message.

Parameters

[in]	handlerPtr	The message handler.
[in]	contextPtr

taf_simRsim_RemoveMessageHandler()

void taf_simRsim_RemoveMessageHandler

(

taf_simRsim_MessageHandlerRef_t

handlerRef

)

Remove handler function for EVENT 'taf_simRsim_Message'

Parameters

[in]

handlerRef

taf_simRsim_SendMessage()

le_result_t taf_simRsim_SendMessage	(	const uint8_t *	messagePtr,
		size_t	messageSize,
		taf_simRsim_CallbackHandlerFunc_t	callbackPtr,
		void *	contextPtr
	)

Sends a message to the remote SIM service service which sends the message to the modem.

Returns

• LE_OK – Successfully sent the message.
• LE_BAD_PARAMETER – Length of the message is too long.

Parameters

[in]	messagePtr	The message.
[in]	messageSize
[in]	callbackPtr	The callback handler.
[in]	contextPtr