#include "legato.h"
#include "taf_sim_interface.h"
#include "taf_simRsp_common.h"
Go to the source code of this file.
|
void | taf_simRsp_ConnectService (void) |
|
le_result_t | taf_simRsp_TryConnectService (void) |
|
LE_FULL_API void | taf_simRsp_SetServerDisconnectHandler (taf_simRsp_DisconnectHandler_t disconnectHandler, void *contextPtr) |
|
LE_FULL_API void | taf_simRsp_SetNonExitServerDisconnectHandler (taf_simRsp_DisconnectHandler_t disconnectHandler, void *contextPtr) |
|
void | taf_simRsp_DisconnectService (void) |
|
taf_simRsp_ProfileDownloadHandlerRef_t | taf_simRsp_AddProfileDownloadHandler (taf_simRsp_ProfileDownloadHandlerFunc_t handlerPtr, void *contextPtr) |
|
void | taf_simRsp_RemoveProfileDownloadHandler (taf_simRsp_ProfileDownloadHandlerRef_t handlerRef) |
|
taf_simRsp_ProfileUserConsentHandlerRef_t | taf_simRsp_AddProfileUserConsentHandler (taf_simRsp_ProfileUserConsentHandlerFunc_t handlerPtr, void *contextPtr) |
|
void | taf_simRsp_RemoveProfileUserConsentHandler (taf_simRsp_ProfileUserConsentHandlerRef_t handlerRef) |
|
taf_simRsp_ProfileConfirmationCodeHandlerRef_t | taf_simRsp_AddProfileConfirmationCodeHandler (taf_simRsp_ProfileConfirmationCodeHandlerFunc_t handlerPtr, void *contextPtr) |
|
void | taf_simRsp_RemoveProfileConfirmationCodeHandler (taf_simRsp_ProfileConfirmationCodeHandlerRef_t handlerRef) |
|
le_result_t | taf_simRsp_GetEID (taf_sim_Id_t slotId, char *eid, size_t eidSize) |
|
le_result_t | taf_simRsp_AddProfile (taf_sim_Id_t slotId, const char *LE_NONNULL activationCode, const char *LE_NONNULL confirmationCode, bool userConsentSupported) |
|
le_result_t | taf_simRsp_DeleteProfile (taf_sim_Id_t slotId, uint32_t profileId) |
|
le_result_t | taf_simRsp_SetProfile (taf_sim_Id_t slotId, uint32_t profileId, bool enable) |
|
le_result_t | taf_simRsp_UpdateNickName (taf_sim_Id_t slotId, uint32_t profileId, const char *LE_NONNULL nickName) |
|
le_result_t | taf_simRsp_GetProfileList (taf_sim_Id_t slotId, taf_simRsp_ProfileListNodeRef_t *profileListPtr, size_t *profileListSizePtr) |
|
le_result_t | taf_simRsp_SetServerAddress (taf_sim_Id_t slotId, const char *LE_NONNULL smdpAdress) |
|
le_result_t | taf_simRsp_GetServerAddress (taf_sim_Id_t slotId, char *smdpAdress, size_t smdpAdressSize, char *smdsdress, size_t smdsdressSize) |
|
le_result_t | taf_simRsp_ProvideUserConsent (taf_sim_Id_t slotId, bool userConsent, taf_simRsp_UserConsentReasonType_t reason) |
|
le_result_t | taf_simRsp_ProvideConfirmationCode (taf_sim_Id_t slotId, const char *LE_NONNULL code) |
|
taf_simRsp_ProfileListNodeRef_t | taf_simRsp_GetProfile (uint32_t index) |
|
uint32_t | taf_simRsp_GetProfileIndex (taf_simRsp_ProfileListNodeRef_t profileRef) |
|
taf_simRsp_ProfileType_t | taf_simRsp_GetProfileType (taf_simRsp_ProfileListNodeRef_t profileRef) |
|
le_result_t | taf_simRsp_GetIccid (taf_simRsp_ProfileListNodeRef_t profileRef, char *iccid, size_t iccidSize) |
|
bool | taf_simRsp_GetProfileActiveStatus (taf_simRsp_ProfileListNodeRef_t profileRef) |
|
le_result_t | taf_simRsp_GetNickName (taf_simRsp_ProfileListNodeRef_t profileRef, char *nickName, size_t nickNameSize) |
|
le_result_t | taf_simRsp_GetName (taf_simRsp_ProfileListNodeRef_t profileRef, char *name, size_t nameSize) |
|
le_result_t | taf_simRsp_GetSpn (taf_simRsp_ProfileListNodeRef_t profileRef, char *spn, size_t spnSize) |
|
taf_simRsp_IconType_t | taf_simRsp_GetIconType (taf_simRsp_ProfileListNodeRef_t profileRef) |
|
taf_simRsp_ProfileClass_t | taf_simRsp_GetProfileClass (taf_simRsp_ProfileListNodeRef_t profileRef) |
|
uint32_t | taf_simRsp_GetMask (taf_simRsp_ProfileListNodeRef_t profileRef) |
|
◆ taf_simRsp_DisconnectHandler_t
typedef void(* taf_simRsp_DisconnectHandler_t) (void *) |
Type for handler called when a server disconnects.
◆ taf_simRsp_ConnectService()
void taf_simRsp_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_simRsp_TryConnectService()
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_simRsp_SetServerDisconnectHandler()
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_simRsp_SetNonExitServerDisconnectHandler()
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_simRsp_DisconnectService()
void taf_simRsp_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_simRsp_AddProfileDownloadHandler()
Add handler function for EVENT 'taf_simRsp_ProfileDownload'
Event for profile download.
- Parameters
-
[in] | handlerPtr | Handler for profile download. |
[in] | contextPtr | |
◆ taf_simRsp_RemoveProfileDownloadHandler()
Remove handler function for EVENT 'taf_simRsp_ProfileDownload'
- Parameters
-
◆ taf_simRsp_AddProfileUserConsentHandler()
Add handler function for EVENT 'taf_simRsp_ProfileUserConsent'
User consent of profile management.
- Parameters
-
[in] | handlerPtr | Handler of user consent. |
[in] | contextPtr | |
◆ taf_simRsp_RemoveProfileUserConsentHandler()
Remove handler function for EVENT 'taf_simRsp_ProfileUserConsent'
- Parameters
-
◆ taf_simRsp_AddProfileConfirmationCodeHandler()
Add handler function for EVENT 'taf_simRsp_ProfileConfirmationCode'
Event for confirmation code of profile.
- Parameters
-
[in] | handlerPtr | Handler of profile confirmation code. |
[in] | contextPtr | |
◆ taf_simRsp_RemoveProfileConfirmationCodeHandler()
Remove handler function for EVENT 'taf_simRsp_ProfileConfirmationCode'
- Parameters
-
◆ taf_simRsp_GetEID()
Request eUICC identifier (EID) for the slot.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
- Parameters
-
[in] | slotId | SIM slot ID. |
[out] | eid | EID as output. |
[in] | eidSize | |
◆ taf_simRsp_AddProfile()
Adds a new profile to the eUICC card and downloads and installs the profile on the eUICC.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
- Parameters
-
[in] | slotId | SIM slot ID. |
[in] | activationCode | Activation code. |
[in] | confirmationCode | Confirmation code. |
[in] | userConsentSupported | Whether user consent is |
◆ taf_simRsp_DeleteProfile()
Deletes a profile from the eUICC card.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
- Parameters
-
[in] | slotId | SIM slot ID. |
[in] | profileId | Profile ID. |
◆ taf_simRsp_SetProfile()
Enables or disables the profile which allows switching another profile on the eUICC card.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
- Parameters
-
[in] | slotId | SIM slot ID. |
[in] | profileId | Profile ID. |
[in] | enable | Enabled or not; true if enabling, false if disabling. |
◆ taf_simRsp_UpdateNickName()
Updates the profile's nick name.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
- Parameters
-
[in] | slotId | SIM slot ID. |
[in] | profileId | Profile ID. |
[in] | nickName | Nick name. |
◆ taf_simRsp_GetProfileList()
Requests a list of profiles supported by the eUICC card.
- Returns
- LE_OK – Succeeded.
- LE_FAULT– Failed.
- Parameters
-
[in] | slotId | SIM slot ID. |
[out] | profileListPtr | Profile list as output. |
[in,out] | profileListSizePtr | |
◆ taf_simRsp_SetServerAddress()
Sets the Subscription Manager Data Preparation (SM-DP+) address on the eUICC. If the SM-DP+ address length is zero then the existing SM-DP+ address on the eUICC is removed.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
- Parameters
-
[in] | slotId | SIM slot ID. |
[in] | smdpAdress | SM-DP+ address. |
◆ taf_simRsp_GetServerAddress()
le_result_t taf_simRsp_GetServerAddress |
( |
taf_sim_Id_t |
slotId, |
|
|
char * |
smdpAdress, |
|
|
size_t |
smdpAdressSize, |
|
|
char * |
smdsdress, |
|
|
size_t |
smdsdressSize |
|
) |
| |
Gets the SM-DP+ address and the Subscription Manager Discovery Server (SMDS) address configured on the eUICC.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
- Parameters
-
[in] | slotId | SIM slot ID. |
[out] | smdpAdress | SM-DP+ address. |
[in] | smdpAdressSize | |
[out] | smdsdress | SMDS address. |
[in] | smdsdressSize | |
◆ taf_simRsp_ProvideUserConsent()
Provides user consent required for downloading and installing a profile. This API should be called in response to a ProfileUserConsent event.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
- Parameters
-
[in] | slotId | SIM slot ID. |
[in] | userConsent | User consent. |
[in] | reason | User consent reason. |
◆ taf_simRsp_ProvideConfirmationCode()
Provides the confirmation code required for downloading and installing the profile. This API should be called in response to a ProfileConfirmationCode event.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
- Parameters
-
[in] | slotId | SIM slot ID. |
[in] | code | Confirmation code. |
◆ taf_simRsp_GetProfile()
Returns the opaque type (ProfileListNode) reference for a profile, specified using the profile index.
- Returns
- ProfileListNode type reference – Succeeded.
- NULL – Failed.
- Parameters
-
◆ taf_simRsp_GetProfileIndex()
Returns profileIndex for a profile, specified using the ProfileListNode type reference.
- Returns
- uint32_t type profile index.
- Parameters
-
◆ taf_simRsp_GetProfileType()
Returns the profile type for a profile, specified using the ProfileListNode type reference.
- Returns
-
- Parameters
-
◆ taf_simRsp_GetIccid()
Gets the ICCID for a profile, specified using the ProfileListNode type reference.
- Returns
- LE_OK – Successful in getting ICCID.
- LE_FAULT – Failure in getting the ICCID.
- Parameters
-
[in] | profileRef | |
[out] | iccid | |
[in] | iccidSize | |
◆ taf_simRsp_GetProfileActiveStatus()
Returns whether or not the specified profile is active.
- Returns
- True – Profile is active.
- FaLSE – Profile is inactive or not found.
- Parameters
-
◆ taf_simRsp_GetNickName()
Gets the nickname for the specified profile.
- Returns
- LE_OK – Successful.
- LE_FAULT – Error occurred while getting the nickname.
- Parameters
-
[in] | profileRef | |
[out] | nickName | |
[in] | nickNameSize | |
◆ taf_simRsp_GetName()
Gets the name for the specified profile.
- Returns
- LE_OK – Successful.
- LE_FAULT – Error occurred while getting the name.
- Parameters
-
[in] | profileRef | |
[out] | name | |
[in] | nameSize | |
◆ taf_simRsp_GetSpn()
Gets the SPN for the specified profile.
- Returns
- LE_OK - Successful
- LE_FAULT - Error occurred while getting the SPN.
- Parameters
-
[in] | profileRef | |
[out] | spn | |
[in] | spnSize | |
◆ taf_simRsp_GetIconType()
Gets the Icon type for the specified profile.
- Returns
-
- Parameters
-
◆ taf_simRsp_GetProfileClass()
Gets the ProfileClass for the specified profile.
- Returns
-
- Parameters
-
◆ taf_simRsp_GetMask()
Gets the Mask for the specified profile.
- Returns
- uint32 – Mask for the profile specified.
- Parameters
-