le_mdmDefs_interface.h File Reference
#include "legato.h"
Go to the source code of this file.
Macros | |
#define | LE_MDMDEFS_PHONE_NUM_MAX_LEN 17 |
#define | LE_MDMDEFS_PHONE_NUM_MAX_BYTES 18 |
Typedefs | |
typedef void(* | le_mdmDefs_DisconnectHandler_t) (void *) |
Enumerations | |
enum | le_mdmDefs_IpVersion_t { LE_MDMDEFS_IPV4 = 0, LE_MDMDEFS_IPV6 = 1, LE_MDMDEFS_IPMAX = 2 } |
Functions | |
void | le_mdmDefs_ConnectService (void) |
le_result_t | le_mdmDefs_TryConnectService (void) |
void | le_mdmDefs_SetServerDisconnectHandler (le_mdmDefs_DisconnectHandler_t disconnectHandler, void *contextPtr) |
void | le_mdmDefs_DisconnectService (void) |
Detailed Description
Definition file common to multiple modem related services.
Copyright (C) Sierra Wireless Inc.
Macro Definition Documentation
#define LE_MDMDEFS_PHONE_NUM_MAX_BYTES 18 |
Cf. ITU-T recommendations E.164/E.163. E.164 numbers can have a maximum of 15 digits except the international prefix ('+' or '00'). One extra byte is added for the null character. One extra byte is added for the null character.
#define LE_MDMDEFS_PHONE_NUM_MAX_LEN 17 |
Cf. ITU-T recommendations E.164/E.163. E.164 numbers can have a maximum of 15 digits except the international prefix ('+' or '00'). One extra byte is added for the null character.
Typedef Documentation
typedef void(* le_mdmDefs_DisconnectHandler_t) (void *) |
Type for handler called when a server disconnects.
Enumeration Type Documentation
Function Documentation
void le_mdmDefs_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.
void le_mdmDefs_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.
void le_mdmDefs_SetServerDisconnectHandler | ( | le_mdmDefs_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_result_t le_mdmDefs_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.