dpyModem Namespace Reference
Deepsy Modem namespace that includes the different enums, structs or method signatures that should be used.
Classes | |
struct | AccessPointNetwork |
struct | CallConfig |
Struct to keep call Configuration as configured by the Voice call. More... | |
struct | CallInfo |
Struct to keep info from a call. More... | |
struct | DATE_INFO |
Defines the struct type used to store the DATE_INFO. More... | |
class | ListObserver |
List Observer class. More... | |
struct | ModemInfo |
Defines the structure containing Modem information. More... | |
struct | ModemStatus |
Defines the status information structure that is obtained after a MODEM STATUS report. More... | |
struct | s_SMSInfo |
Defines the structure containing SMS information. More... | |
struct | SimInfo |
Defines the structure containing Sim information. More... | |
struct | UTC_INFO |
Defines the struct type used to store the UTC_INFO. More... | |
Typedefs | |
typedef boost::function< void(boost::system::error_code, std::list< std::string > modems)> | modem_list_handler_function |
Prototype of the handler function for getting available modems. More... | |
typedef boost::function< void(boost::system::error_code, std::list< std::string > sims)> | sim_list_handler_function |
Prototype of the handler function for getting available sims. More... | |
typedef boost::function< void(boost::system::error_code error_code, std::string modemid, struct ModemStatus &status)> | modem_status_handler_function |
Prototype of the handler function for modem status getter and events. More... | |
typedef boost::function< void(boost::system::error_code, std::string modemid, ListEvent event)> | modem_list_event_handler_function |
Prototype of the handler function for subscribing to list events. More... | |
typedef boost::function< void(boost::system::error_code, std::string modemid, dpyModem::ModemWarning warning)> | modem_warning_event_handler_function |
Prototype of the handler function for subscribing to modem warnings. More... | |
typedef boost::function< void(boost::system::error_code error_code, std::string modemid, const bool &enabled)> | modem_data_connection_status_handler_function |
Prototype of the handler function to receive modem data connection status. More... | |
typedef boost::function< void(boost::system::error_code, ModemInfo modeminfo)> | modem_info_handler_function |
Prototype of the handler function used to get a specific modem information. More... | |
typedef boost::function< void(boost::system::error_code, SimInfo siminfo)> | sim_info_handler_function |
Prototype of the handler function used to get a specific sim information. More... | |
typedef boost::function< void(boost::system::error_code, std::string modemid, std::string simid, ListEvent event)> | sim_list_event_handler_function |
Prototype of the handler function for subscribing to list events. More... | |
typedef boost::function< void(boost::system::error_code, std::string simid, dpyModem::SimStatus status)> | simStatus_handler_function |
Prototype of the handler function for sim status getter and events. More... | |
typedef boost::function< void(const bool &available)> | service_availability_handler_function |
Prototype of the handler function used to monitor service availability. More... | |
typedef boost::function< void(boost::system::error_code &ec, ModemWarning warning_notif)> | warning_handler_function |
Prototype of the handler function for getModemNotifications_S method. | |
typedef boost::function< void(boost::system::error_code error_code, MODEM_INFO type, const std::string &value)> | get_info_handler_function |
Prototype of the handler function for getModemInfo method. | |
typedef boost::function< void(boost::system::error_code error_code, const AccessPointNetwork &apn_info, const bool &forced_apn)> | get_apn_handler_function |
Prototype of the handler function for obtaining apn information (getCurrentApn or getApnByImsi methods) | |
typedef boost::function< void(boost::system::error_code error_code, const AccessPointNetwork &apn_info)> | get_apn_by_imsi_handler_function |
Prototype of the handler function for obtaining apn information (getCurrentApn or getApnByImsi methods) | |
typedef boost::function< void(boost::system::error_code error_code)> | result_handler_function |
Prototype of the handler function for obtaining result of the different operations. | |
typedef boost::function< void(boost::system::error_code error_code, const bool &enabled)> | data_connection_status_handler_function |
Prototype of the handler function for isDataConnectionEnabled method. | |
typedef boost::function< void(boost::system::error_code error_code, const std::string &modemId, const std::string &interfaceName, std::map< dpyNetworking::Statistics, uint32_t >statisticsValues, const std::string &interfaceIpAddress)> | interface_statistics_function_handler |
Prototype of the handler function for asyncGetInterfaceStatistics method. | |
typedef boost::function< void(boost::system::error_code error_code, std::string modemid, int simSlot)> | sim_slot_handler_function |
Prototype of the handler function for get the current sim slot. More... | |
typedef boost::function< void(boost::system::error_code error_code, dpyModem::AccessPointNetwork found_apn)> | forced_apn_handler_function |
Prototype of the handler function for get the global forced APN. More... | |
Enumerations | |
enum | MODEM_INFO { MANUFACTURER, MODEL, FW_VERSION, IMEI, SIM_IMSI, SIM_ICCID, SIM_OPERATOR, SIM_APN } |
Defines the possible information that can be queried. More... | |
enum | ModemOperation { DISABLE, ENABLE, SLEEP, SW_RESTART, HW_RESTART, DISABLE_DATA_CONNECTION, ENABLE_DATA_CONNECTION } |
Defines the possible operations that can be queried to a modem. More... | |
enum | ListEvent { ADDED = 0, REMOVED = 1 } |
enum | ModemType { MODEMMANAGERGENERIC_USB = 0, MODEMMANAGER_EM7455 = 1, BGS2W_PREINSTALLED = 2, MODEMMANAGER_RC7620 = 3, MODEMMANAGER_EC25 = 4, MODEMMANAGER_WP7607 = 5, MODEMMANAGER_RC7611 = 6 } |
Modem types. | |
enum | ModemWarning { NOTIFY_UNDERVOLTAGE, NOTIFY_OVERVOLTAGE, NOTIFY_CLOSE_TO_UNDERTEMPERATURE, NOTIFY_CLOSE_TO_OVERTEMPERATURE, NOTIFY_UNDERTEMPERATURE, NOTIFY_OVERTEMPERATURE, NOTIFY_BACK_TO_NORMAL_TEMPERATURE, NOTIFY_JAMMING, NOTIFY_SHUTDOWN, NOTIFY_RESTARTED } |
Defines the possible warnings that the modem can report during its operation. More... | |
enum | SimStatus { SIM_NOT_INSERTED, SIM_INVALID_OR_UNSUPPORTED, SIM_LOCKED, SIM_LOCKED_PIN, SIM_LOCKED_PIN2, SIM_LOCKED_PUK, SIM_READY } |
Defines the possible states in which SIM card may be. More... | |
enum | CallStatus { CALLS_DISABLED = 0, WAITING = 1, RINGING = 2, DIALING = 3, CONVERSATION = 4, HELD = 5, FINISHED = 6, ALERTING = 7, DROPPED = 8 } |
Defines the possible call status. More... | |
Modem status information | |
This enumerations and structures give easy access to the main parameters that describe the status of the modem at a given moment | |
enum | ModemState { DISABLED, RESTARTING, SLEEPING, ENABLING_MODEM, ENABLED_SIM_READY, SERVICE_AVAILABLE_GOOD_SIGNAL, CELLULAR_NETWORK_REG_HOME, CELLULAR_NETWORK_REG_ROAMING, DATA_CONNECTION_NOT_AVAILABLE, DATA_CONNECTION_ENABLED, DATA_CONNECTION_CONNECTING, DATA_CONNECTION_ACTIVE } |
enum | ModemPowerStatus { MODEM_DISABLED, MODEM_RESTART, MODEM_SLEEP, MODEM_ON } |
Defines the possible MODEM POWER states that the modem can be in. More... | |
enum | SignalQuality { ANTENNA_NOT_DETECTED, POOR_SIGNAL_STRENGTH, FAIR_SIGNAL_STRENGTH, GOOD_SIGNAL_STRENGTH, EXCELLENT_SIGNAL_STRENGTH } |
Defines the possible SIGNAL QUALITY results that that can be obtained. More... | |
enum | NetworkStatus { NOT_REGISTERED, SEARCHING_OPERATOR, REGISTERED_HOME_NET, REGISTERED_ROAMING, REGISTRATION_DENIED } |
Defines the possible Cellular network registration status that can be reported. Note that this field informs only about network registration, not modem status. More... | |
enum | GPRS_NETWORK_STATUS { GPRS_NOT_REGISTERED, GPRS_SEARCHING_OPERATOR, GPRS_REGISTERED_HOME_NET, GPRS_REGISTERED_ROAMING, GPRS_REGISTRATION_DENIED } |
Defines the possible GPRS network registration status that can be reported. Note that this field informs only about network registration, not modem status. More... | |
enum | NetworkMode { MODE_NONE = 0, MODE_CS = 1, MODE_2G = 2, MODE_3G = 4, MODE_4G = 8, MODE_ANY = 16 } |
Defines the possible network modes. More... | |
enum | AccessTechnology { NONE, POTS, GSM, GPRS, EDGE, UMTS, HSPA, HSDPA, HSUPA, CDMA, LTE } |
Defines the possible network access technologies a modem can make use of in order to communicate with the network. More... | |
Sim related types | |
This enumerations and structures give easy access to the main parameters that describe the status of a SIM at a given moment | |
enum | SmsEvent { SENT, RECEIVED, DELETED, STORAGE_FULL } |
Defines the possible sms notifications that a sim can report. More... | |
enum | CallDir { DIR_OUTGOING = 0, DIR_INCOMING = 1, DIR_UNKNOWN = 2 } |
Direction. More... | |
enum | CallStat { STAT_ACTIVE = 0, STAT_HELD = 1, STAT_DIALING = 2, STAT_ALERTING = 3, STAT_INCOMING = 4, STAT_WAITING = 5, STAT_TERMINATING = 6, STAT_DROPPED = 7 } |
State. More... | |
enum | CallSourceStatus { NOT_AVAILABLE = 0, IDLE = 1, BUSY = 2 } |
Defines the possible status that a voice call source can report regarding calls. More... | |
enum | CallMode { MODE_VOICE = 0, MODE_DATA = 1, MODE_FAX = 2, MODE_VOICE_DATA = 3, MODE_VOICE_ALT_DATA = 4, MODE_VOICE_ALT_FAX = 5, MODE_DATA_VOICE = 6, MODE_DATA_ALT_VOICE = 7, MODE_FAX_ALT_VOICE = 8, MODE_UNKNOWN = 9 } |
Mode. More... | |
enum | CallMpty { MPTY_INACTIVE = 0, MPTY_ACTIVE = 1 } |
Multiparty. More... | |
enum | CallTrafficChannel { TRAFFIC_CHANNEL_NOT_ASSIGNED = 0, TRAFFIC_CHANNEL_ASSIGNED = 1 } |
Traffic channel assigned. More... | |
enum | CallType { TYPE_RESTRICTED_NUM = 0, TYPE_INTERNATIONAL_CODE = 1, TYPE_NATIONAL_NUM = 2, TYPE_SUPPLEM_SERVICE_CODE = 3, TYPE_OTHERWISE = 4 } |
Type of address octet as defined by 3GPP. More... | |
Typedef Documentation
typedef boost::function<void(boost::system::error_code error_code, dpyModem::AccessPointNetwork found_apn)> forced_apn_handler_function |
- Parameters
-
error_code error code (if any) found_apn Access Point Network information
typedef boost::function<void(boost::system::error_code error_code,std::string modemid, const bool &enabled)> modem_data_connection_status_handler_function |
- Parameters
-
error_code error code (if any) modemid modem id enabled status of the data connection flag
typedef boost::function<void(boost::system::error_code, ModemInfo modeminfo)> modem_info_handler_function |
- Parameters
-
error_code error code (if any) modeminfo modem related information
typedef boost::function<void(boost::system::error_code, std::string modemid, ListEvent event)> modem_list_event_handler_function |
- Parameters
-
error_code error code (if any) modemid modem id event in the list (ADDED,REMOVED)
typedef boost::function<void(boost::system::error_code, std::list<std::string> modems)> modem_list_handler_function |
- Parameters
-
error_code error code (if any) modems list of modem ids
typedef boost::function<void(boost::system::error_code error_code,std::string modemid, struct ModemStatus& status)> modem_status_handler_function |
- Parameters
-
error_code error code (if any) modemid modem id status structure describing the current status of the modem
typedef boost::function<void(boost::system::error_code, std::string modemid, dpyModem::ModemWarning warning)> modem_warning_event_handler_function |
- Parameters
-
error_code error code (if any) modemid modem id warning notification received
typedef boost::function<void(const bool &available)> service_availability_handler_function |
- Parameters
-
available true if the service is available, false otherwise
typedef boost::function<void(boost::system::error_code, SimInfo siminfo)> sim_info_handler_function |
- Parameters
-
error_code error code (if any) siminfo sim related information
typedef boost::function<void(boost::system::error_code, std::string modemid, std::string simid, ListEvent event)> sim_list_event_handler_function |
- Parameters
-
error_code error code (if any) modemid modem id simid sim id event in the list (ADDED,REMOVED)
typedef boost::function<void(boost::system::error_code, std::list<std::string> sims)> sim_list_handler_function |
- Parameters
-
error_code error code (if any) sims list of sim ids
typedef boost::function<void(boost::system::error_code error_code, std::string modemid, int simSlot)> sim_slot_handler_function |
- Parameters
-
error_code error code (if any) modemid modem id simSlot current sim slot in use
typedef boost::function<void(boost::system::error_code, std::string simid, dpyModem::SimStatus status)> simStatus_handler_function |
- Parameters
-
error_code error code (if any) simid sim id status the sim status
Enumeration Type Documentation
enum AccessTechnology |
enum CallDir |
enum CallMode |
enum CallMpty |
enum CallSourceStatus |
enum CallStat |
enum CallTrafficChannel |
enum CallType |
enum GPRS_NETWORK_STATUS |
enum ListEvent |
enum MODEM_INFO |
enum ModemOperation |
enum ModemPowerStatus |
enum ModemState |
Defines the MODEM STATES that the modem can be in
enum ModemWarning |
enum NetworkMode |
enum NetworkStatus |
enum SignalQuality |
enum SmsEvent |