Go to the source code of this file.
Classes | |
| class | YCellRecord |
| class | YCellular |
Macros | |
| #define | _Y_AIRPLANEMODE_ENUM |
| #define | _Y_CELLTYPE_ENUM |
| #define | _Y_ENABLEDATA_ENUM |
| #define | Y_APN_INVALID (YAPI_INVALID_STRING) |
| #define | Y_APNSECRET_INVALID (YAPI_INVALID_STRING) |
| #define | Y_CELLIDENTIFIER_INVALID (YAPI_INVALID_STRING) |
| #define | Y_CELLOPERATOR_INVALID (YAPI_INVALID_STRING) |
| #define | Y_COMMAND_INVALID (YAPI_INVALID_STRING) |
| #define | Y_DATARECEIVED_INVALID (YAPI_INVALID_UINT) |
| #define | Y_DATASENT_INVALID (YAPI_INVALID_UINT) |
| #define | Y_IMSI_INVALID (YAPI_INVALID_STRING) |
| #define | Y_LINKQUALITY_INVALID (YAPI_INVALID_UINT) |
| #define | Y_LOCKEDOPERATOR_INVALID (YAPI_INVALID_STRING) |
| #define | Y_MESSAGE_INVALID (YAPI_INVALID_STRING) |
| #define | Y_PIN_INVALID (YAPI_INVALID_STRING) |
| #define | Y_PINGINTERVAL_INVALID (YAPI_INVALID_UINT) |
Typedefs | |
| typedef void(* | YCellularValueCallback) (YCellular *func, const string &functionValue) |
Enumerations | |
| enum | Y_AIRPLANEMODE_enum { Y_AIRPLANEMODE_OFF = 0, Y_AIRPLANEMODE_ON = 1, Y_AIRPLANEMODE_INVALID = -1 } |
| enum | Y_CELLTYPE_enum { Y_CELLTYPE_GPRS = 0, Y_CELLTYPE_EGPRS = 1, Y_CELLTYPE_WCDMA = 2, Y_CELLTYPE_HSDPA = 3, Y_CELLTYPE_NONE = 4, Y_CELLTYPE_CDMA = 5, Y_CELLTYPE_INVALID = -1 } |
| enum | Y_ENABLEDATA_enum { Y_ENABLEDATA_HOMENETWORK = 0, Y_ENABLEDATA_ROAMING = 1, Y_ENABLEDATA_NEVER = 2, Y_ENABLEDATA_NEUTRALITY = 3, Y_ENABLEDATA_INVALID = -1 } |
Functions | |
| YCellular * | yFindCellular (const string &func) |
| YCellular * | yFirstCellular (void) |
Macro Definition Documentation
| #define _Y_AIRPLANEMODE_ENUM |
Definition at line 68 of file yocto_cellular.h.
| #define _Y_CELLTYPE_ENUM |
Definition at line 56 of file yocto_cellular.h.
| #define _Y_ENABLEDATA_ENUM |
Definition at line 76 of file yocto_cellular.h.
| #define Y_APN_INVALID (YAPI_INVALID_STRING) |
Definition at line 92 of file yocto_cellular.h.
| #define Y_APNSECRET_INVALID (YAPI_INVALID_STRING) |
Definition at line 93 of file yocto_cellular.h.
| #define Y_CELLIDENTIFIER_INVALID (YAPI_INVALID_STRING) |
Definition at line 87 of file yocto_cellular.h.
| #define Y_CELLOPERATOR_INVALID (YAPI_INVALID_STRING) |
Definition at line 86 of file yocto_cellular.h.
| #define Y_COMMAND_INVALID (YAPI_INVALID_STRING) |
Definition at line 97 of file yocto_cellular.h.
| #define Y_DATARECEIVED_INVALID (YAPI_INVALID_UINT) |
Definition at line 96 of file yocto_cellular.h.
| #define Y_DATASENT_INVALID (YAPI_INVALID_UINT) |
Definition at line 95 of file yocto_cellular.h.
| #define Y_IMSI_INVALID (YAPI_INVALID_STRING) |
Definition at line 88 of file yocto_cellular.h.
| #define Y_LINKQUALITY_INVALID (YAPI_INVALID_UINT) |
Definition at line 85 of file yocto_cellular.h.
| #define Y_LOCKEDOPERATOR_INVALID (YAPI_INVALID_STRING) |
Definition at line 91 of file yocto_cellular.h.
| #define Y_MESSAGE_INVALID (YAPI_INVALID_STRING) |
Definition at line 89 of file yocto_cellular.h.
| #define Y_PIN_INVALID (YAPI_INVALID_STRING) |
Definition at line 90 of file yocto_cellular.h.
| #define Y_PINGINTERVAL_INVALID (YAPI_INVALID_UINT) |
Definition at line 94 of file yocto_cellular.h.
Typedef Documentation
| typedef void(* YCellularValueCallback) (YCellular *func, const string &functionValue) |
Definition at line 54 of file yocto_cellular.h.
Enumeration Type Documentation
| enum Y_AIRPLANEMODE_enum |
| Enumerator | |
|---|---|
| Y_AIRPLANEMODE_OFF | |
| Y_AIRPLANEMODE_ON | |
| Y_AIRPLANEMODE_INVALID | |
Definition at line 69 of file yocto_cellular.h.
| enum Y_CELLTYPE_enum |
| Enumerator | |
|---|---|
| Y_CELLTYPE_GPRS | |
| Y_CELLTYPE_EGPRS | |
| Y_CELLTYPE_WCDMA | |
| Y_CELLTYPE_HSDPA | |
| Y_CELLTYPE_NONE | |
| Y_CELLTYPE_CDMA | |
| Y_CELLTYPE_INVALID | |
Definition at line 57 of file yocto_cellular.h.
| enum Y_ENABLEDATA_enum |
| Enumerator | |
|---|---|
| Y_ENABLEDATA_HOMENETWORK | |
| Y_ENABLEDATA_ROAMING | |
| Y_ENABLEDATA_NEVER | |
| Y_ENABLEDATA_NEUTRALITY | |
| Y_ENABLEDATA_INVALID | |
Definition at line 77 of file yocto_cellular.h.
Function Documentation
|
inline |
Retrieves a cellular interface for a given identifier. The identifier can be specified using several formats:
- FunctionLogicalName
- ModuleSerialNumber.FunctionIdentifier
- ModuleSerialNumber.FunctionLogicalName
- ModuleLogicalName.FunctionIdentifier
- ModuleLogicalName.FunctionLogicalName
This function does not require that the cellular interface is online at the time it is invoked. The returned object is nevertheless valid. Use the method YCellular.isOnline() to test if the cellular interface is indeed online at a given time. In case of ambiguity when looking for a cellular interface by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name.
If a call to this object's is_online() method returns FALSE although you are certain that the matching device is plugged, make sure that you did call registerHub() at application initialization time.
- Parameters
-
func : a string that uniquely characterizes the cellular interface
- Returns
- a YCellular object allowing you to drive the cellular interface.
Definition at line 749 of file yocto_cellular.h.
|
inline |
Starts the enumeration of cellular interfaces currently accessible. Use the method YCellular.nextCellular() to iterate on next cellular interfaces.
- Returns
- a pointer to a YCellular object, corresponding to the first cellular interface currently online, or a NULL pointer if there are none.
Definition at line 760 of file yocto_cellular.h.