Go to the source code of this file.
Classes | |
| class | YNetwork |
Typedefs | |
| typedef void(* | YNetworkValueCallback) (YNetwork *func, const string &functionValue) |
Enumerations | |
| enum | Y_CALLBACKENCODING_enum { Y_CALLBACKENCODING_FORM = 0, Y_CALLBACKENCODING_JSON = 1, Y_CALLBACKENCODING_JSON_ARRAY = 2, Y_CALLBACKENCODING_CSV = 3, Y_CALLBACKENCODING_YOCTO_API = 4, Y_CALLBACKENCODING_JSON_NUM = 5, Y_CALLBACKENCODING_EMONCMS = 6, Y_CALLBACKENCODING_AZURE = 7, Y_CALLBACKENCODING_INFLUXDB = 8, Y_CALLBACKENCODING_MQTT = 9, Y_CALLBACKENCODING_YOCTO_API_JZON = 10, Y_CALLBACKENCODING_INVALID = -1 } |
| enum | Y_CALLBACKMETHOD_enum { Y_CALLBACKMETHOD_POST = 0, Y_CALLBACKMETHOD_GET = 1, Y_CALLBACKMETHOD_PUT = 2, Y_CALLBACKMETHOD_INVALID = -1 } |
| enum | Y_DISCOVERABLE_enum { Y_DISCOVERABLE_FALSE = 0, Y_DISCOVERABLE_TRUE = 1, Y_DISCOVERABLE_INVALID = -1 } |
| enum | Y_READINESS_enum { Y_READINESS_DOWN = 0, Y_READINESS_EXISTS = 1, Y_READINESS_LINKED = 2, Y_READINESS_LAN_OK = 3, Y_READINESS_WWW_OK = 4, Y_READINESS_INVALID = -1 } |
Functions | |
| YNetwork * | yFindNetwork (const string &func) |
| YNetwork * | yFirstNetwork (void) |
Macro Definition Documentation
| #define _Y_CALLBACKENCODING_ENUM |
Definition at line 84 of file yocto_network.h.
| #define _Y_CALLBACKMETHOD_ENUM |
Definition at line 75 of file yocto_network.h.
| #define _Y_DISCOVERABLE_ENUM |
Definition at line 67 of file yocto_network.h.
| #define _Y_READINESS_ENUM |
Definition at line 56 of file yocto_network.h.
| #define Y_ADMINPASSWORD_INVALID (YAPI_INVALID_STRING) |
Definition at line 109 of file yocto_network.h.
| #define Y_CALLBACKCREDENTIALS_INVALID (YAPI_INVALID_STRING) |
Definition at line 114 of file yocto_network.h.
| #define Y_CALLBACKINITIALDELAY_INVALID (YAPI_INVALID_UINT) |
Definition at line 115 of file yocto_network.h.
| #define Y_CALLBACKMAXDELAY_INVALID (YAPI_INVALID_UINT) |
Definition at line 118 of file yocto_network.h.
| #define Y_CALLBACKMINDELAY_INVALID (YAPI_INVALID_UINT) |
Definition at line 117 of file yocto_network.h.
| #define Y_CALLBACKSCHEDULE_INVALID (YAPI_INVALID_STRING) |
Definition at line 116 of file yocto_network.h.
| #define Y_CALLBACKURL_INVALID (YAPI_INVALID_STRING) |
Definition at line 113 of file yocto_network.h.
| #define Y_DEFAULTPAGE_INVALID (YAPI_INVALID_STRING) |
Definition at line 111 of file yocto_network.h.
| #define Y_HTTPPORT_INVALID (YAPI_INVALID_UINT) |
Definition at line 110 of file yocto_network.h.
| #define Y_IPADDRESS_INVALID (YAPI_INVALID_STRING) |
Definition at line 101 of file yocto_network.h.
| #define Y_IPCONFIG_INVALID (YAPI_INVALID_STRING) |
Definition at line 104 of file yocto_network.h.
| #define Y_MACADDRESS_INVALID (YAPI_INVALID_STRING) |
Definition at line 100 of file yocto_network.h.
| #define Y_NTPSERVER_INVALID (YAPI_INVALID_STRING) |
Definition at line 107 of file yocto_network.h.
| #define Y_POECURRENT_INVALID (YAPI_INVALID_UINT) |
Definition at line 119 of file yocto_network.h.
| #define Y_PRIMARYDNS_INVALID (YAPI_INVALID_STRING) |
Definition at line 105 of file yocto_network.h.
| #define Y_ROUTER_INVALID (YAPI_INVALID_STRING) |
Definition at line 103 of file yocto_network.h.
| #define Y_SECONDARYDNS_INVALID (YAPI_INVALID_STRING) |
Definition at line 106 of file yocto_network.h.
| #define Y_SUBNETMASK_INVALID (YAPI_INVALID_STRING) |
Definition at line 102 of file yocto_network.h.
| #define Y_USERPASSWORD_INVALID (YAPI_INVALID_STRING) |
Definition at line 108 of file yocto_network.h.
| #define Y_WWWWATCHDOGDELAY_INVALID (YAPI_INVALID_UINT) |
Definition at line 112 of file yocto_network.h.
Typedef Documentation
| typedef void(* YNetworkValueCallback) (YNetwork *func, const string &functionValue) |
Definition at line 54 of file yocto_network.h.
Enumeration Type Documentation
Definition at line 85 of file yocto_network.h.
| Enumerator | |
|---|---|
| Y_CALLBACKMETHOD_POST | |
| Y_CALLBACKMETHOD_GET | |
| Y_CALLBACKMETHOD_PUT | |
| Y_CALLBACKMETHOD_INVALID | |
Definition at line 76 of file yocto_network.h.
| enum Y_DISCOVERABLE_enum |
| Enumerator | |
|---|---|
| Y_DISCOVERABLE_FALSE | |
| Y_DISCOVERABLE_TRUE | |
| Y_DISCOVERABLE_INVALID | |
Definition at line 68 of file yocto_network.h.
| enum Y_READINESS_enum |
| Enumerator | |
|---|---|
| Y_READINESS_DOWN | |
| Y_READINESS_EXISTS | |
| Y_READINESS_LINKED | |
| Y_READINESS_LAN_OK | |
| Y_READINESS_WWW_OK | |
| Y_READINESS_INVALID | |
Definition at line 57 of file yocto_network.h.
Function Documentation
|
inline |
Retrieves a network 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 network interface is online at the time it is invoked. The returned object is nevertheless valid. Use the method YNetwork.isOnline() to test if the network interface is indeed online at a given time. In case of ambiguity when looking for a network 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 network interface
- Returns
- a YNetwork object allowing you to drive the network interface.
Definition at line 1029 of file yocto_network.h.
|
inline |
Starts the enumeration of network interfaces currently accessible. Use the method YNetwork.nextNetwork() to iterate on next network interfaces.
- Returns
- a pointer to a YNetwork object, corresponding to the first network interface currently online, or a NULL pointer if there are none.
Definition at line 1040 of file yocto_network.h.