Macros | Typedefs | Functions

le_rsim_interface.h File Reference

#include "legato.h"

Go to the source code of this file.

Macros

#define LE_RSIM_MAX_MSG_SIZE   276
 
#define LE_RSIM_MIN_MSG_SIZE   200
 

Typedefs

typedef void(* le_rsim_DisconnectHandler_t) (void *)
 
typedef struct le_rsim_MessageHandler * le_rsim_MessageHandlerRef_t
 
typedef void(* le_rsim_MessageHandlerFunc_t) (const uint8_t *messagePtr, size_t messageSize, void *contextPtr)
 
typedef void(* le_rsim_CallbackHandlerFunc_t) (uint8_t messageId, le_result_t result, void *contextPtr)
 

Functions

void le_rsim_ConnectService (void)
 
le_result_t le_rsim_TryConnectService (void)
 
void le_rsim_SetServerDisconnectHandler (le_rsim_DisconnectHandler_t disconnectHandler, void *contextPtr)
 
void le_rsim_DisconnectService (void)
 
le_rsim_MessageHandlerRef_t le_rsim_AddMessageHandler (le_rsim_MessageHandlerFunc_t handlerPtr, void *contextPtr)
 
void le_rsim_RemoveMessageHandler (le_rsim_MessageHandlerRef_t handlerRef)
 
le_result_t le_rsim_SendMessage (const uint8_t *messagePtr, size_t messageSize, le_rsim_CallbackHandlerFunc_t callbackPtr, void *contextPtr)
 

Detailed Description

Legato Remote SIM service API.

Copyright (C) Sierra Wireless Inc.

Macro Definition Documentation

◆ LE_RSIM_MAX_MSG_SIZE

#define LE_RSIM_MAX_MSG_SIZE   276

Remote SIM maximal message size

Note
The maximal message size of 276 bytes is based on the longest possible SAP message. This message is a TRANSFER_APDU_RESP composed of a 4-byte SAP header, a 8-byte ResultCode, a 4-byte ResponseAPDU header, 256 bytes of APDU data, 2 status bytes and 2 padding bytes.

◆ LE_RSIM_MIN_MSG_SIZE

#define LE_RSIM_MIN_MSG_SIZE   200

Remote SIM minimal message size

Note
This minimal length is set to ensure that the communication with the remote SIM server can be effective.

Typedef Documentation

◆ le_rsim_CallbackHandlerFunc_t

typedef void(* le_rsim_CallbackHandlerFunc_t) (uint8_t messageId, le_result_t result, void *contextPtr)

Handler for message sending result

◆ le_rsim_DisconnectHandler_t

typedef void(* le_rsim_DisconnectHandler_t) (void *)

Type for handler called when a server disconnects.

◆ le_rsim_MessageHandlerFunc_t

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

Handler for message notification

◆ le_rsim_MessageHandlerRef_t

typedef struct le_rsim_MessageHandler* le_rsim_MessageHandlerRef_t

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

Function Documentation

◆ le_rsim_AddMessageHandler()

le_rsim_MessageHandlerRef_t le_rsim_AddMessageHandler ( le_rsim_MessageHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

Add handler function for EVENT 'le_rsim_Message'

This event is used to notify and send a message

Parameters
[in]handlerPtr
[in]contextPtr

◆ le_rsim_ConnectService()

void le_rsim_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 Client-specific Functions.

This function is created automatically.

◆ le_rsim_DisconnectService()

void le_rsim_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 Client-specific Functions.

This function is created automatically.

◆ le_rsim_RemoveMessageHandler()

void le_rsim_RemoveMessageHandler ( le_rsim_MessageHandlerRef_t  handlerRef)

Remove handler function for EVENT 'le_rsim_Message'

Parameters
[in]handlerRef

◆ le_rsim_SendMessage()

le_result_t le_rsim_SendMessage ( const uint8_t *  messagePtr,
size_t  messageSize,
le_rsim_CallbackHandlerFunc_t  callbackPtr,
void *  contextPtr 
)

This function is called by the application to send a message to the Legato remote SIM service

Returns
  • LE_OK Function succeeded
  • LE_BAD_PARAMETER Message is too long
Warning
The sending process is asynchronous: only the message length is checked by this function before returning a result. A callback function should be passed as a parameter in order to be notified of the message sending result.
Parameters
[in]messagePtrMessage to send
[in]messageSize
[in]callbackPtrCallback for sending result
[in]contextPtr

◆ le_rsim_SetServerDisconnectHandler()

void le_rsim_SetServerDisconnectHandler ( le_rsim_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.

◆ le_rsim_TryConnectService()

le_result_t le_rsim_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 Client-specific Functions.

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.