yocto_wireless.h File Reference

#include "yocto_api.h"
#include <cfloat>
#include <cmath>
#include <map>

Include dependency graph for yocto_wireless.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	YWireless
class	YWlanRecord

Macros
#define	_Y_SECURITY_ENUM
#define	_Y_WLANSTATE_ENUM
#define	Y_CHANNEL_INVALID   (YAPI_INVALID_UINT)
#define	Y_LINKQUALITY_INVALID   (YAPI_INVALID_UINT)
#define	Y_MESSAGE_INVALID   (YAPI_INVALID_STRING)
#define	Y_SSID_INVALID   (YAPI_INVALID_STRING)
#define	Y_WLANCONFIG_INVALID   (YAPI_INVALID_STRING)

Typedefs
typedef void(*	YWirelessValueCallback) (YWireless *func, const string &functionValue)

Enumerations
enum	Y_SECURITY_enum {   Y_SECURITY_UNKNOWN = 0, Y_SECURITY_OPEN = 1, Y_SECURITY_WEP = 2, Y_SECURITY_WPA = 3,   Y_SECURITY_WPA2 = 4, Y_SECURITY_INVALID = -1 }
enum	Y_WLANSTATE_enum {   Y_WLANSTATE_DOWN = 0, Y_WLANSTATE_SCANNING = 1, Y_WLANSTATE_CONNECTED = 2, Y_WLANSTATE_REJECTED = 3,   Y_WLANSTATE_INVALID = -1 }

Functions
YWireless *	yFindWireless (const string &func)
YWireless *	yFirstWireless (void)

Macro Definition Documentation

#define _Y_SECURITY_ENUM

Definition at line 53 of file yocto_wireless.h.

#define _Y_WLANSTATE_ENUM

Definition at line 64 of file yocto_wireless.h.

#define Y_CHANNEL_INVALID   (YAPI_INVALID_UINT)

Definition at line 75 of file yocto_wireless.h.

#define Y_LINKQUALITY_INVALID   (YAPI_INVALID_UINT)

Definition at line 73 of file yocto_wireless.h.

#define Y_MESSAGE_INVALID   (YAPI_INVALID_STRING)

Definition at line 76 of file yocto_wireless.h.

#define Y_SSID_INVALID   (YAPI_INVALID_STRING)

Definition at line 74 of file yocto_wireless.h.

#define Y_WLANCONFIG_INVALID   (YAPI_INVALID_STRING)

Definition at line 77 of file yocto_wireless.h.

Typedef Documentation

typedef void(* YWirelessValueCallback) (YWireless *func, const string &functionValue)

Definition at line 51 of file yocto_wireless.h.

Enumeration Type Documentation

enum Y_SECURITY_enum

Enumerator
Y_SECURITY_UNKNOWN
Y_SECURITY_OPEN
Y_SECURITY_WEP
Y_SECURITY_WPA
Y_SECURITY_WPA2
Y_SECURITY_INVALID

Definition at line 54 of file yocto_wireless.h.

enum Y_WLANSTATE_enum

Enumerator
Y_WLANSTATE_DOWN
Y_WLANSTATE_SCANNING
Y_WLANSTATE_CONNECTED
Y_WLANSTATE_REJECTED
Y_WLANSTATE_INVALID

Definition at line 65 of file yocto_wireless.h.

Function Documentation

YWireless* yFindWireless ( const string &  func )

inline

Retrieves a wireless lan 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 wireless lan interface is online at the time it is invoked. The returned object is nevertheless valid. Use the method YWireless.isOnline() to test if the wireless lan interface is indeed online at a given time. In case of ambiguity when looking for a wireless lan 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 wireless lan interface

Returns

a YWireless object allowing you to drive the wireless lan interface.

Definition at line 471 of file yocto_wireless.h.

YWireless* yFirstWireless ( void  )

inline

Starts the enumeration of wireless lan interfaces currently accessible. Use the method YWireless.nextWireless() to iterate on next wireless lan interfaces.

Returns

a pointer to a YWireless object, corresponding to the first wireless lan interface currently online, or a NULL pointer if there are none.

Definition at line 482 of file yocto_wireless.h.