yocto_bluetoothlink.h File Reference

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

Include dependency graph for yocto_bluetoothlink.h:

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

Go to the source code of this file.

Classes
class	YBluetoothLink

Macros
#define	_Y_LINKSTATE_ENUM
#define	_Y_MUTE_ENUM
#define	Y_COMMAND_INVALID   (YAPI_INVALID_STRING)
#define	Y_LINKQUALITY_INVALID   (YAPI_INVALID_UINT)
#define	Y_OWNADDRESS_INVALID   (YAPI_INVALID_STRING)
#define	Y_PAIRINGPIN_INVALID   (YAPI_INVALID_STRING)
#define	Y_PREAMPLIFIER_INVALID   (YAPI_INVALID_UINT)
#define	Y_REMOTEADDRESS_INVALID   (YAPI_INVALID_STRING)
#define	Y_REMOTENAME_INVALID   (YAPI_INVALID_STRING)
#define	Y_VOLUME_INVALID   (YAPI_INVALID_UINT)

Typedefs
typedef void(*	YBluetoothLinkValueCallback) (YBluetoothLink *func, const string &functionValue)

Enumerations
enum	Y_LINKSTATE_enum {   Y_LINKSTATE_DOWN = 0, Y_LINKSTATE_FREE = 1, Y_LINKSTATE_SEARCH = 2, Y_LINKSTATE_EXISTS = 3,   Y_LINKSTATE_LINKED = 4, Y_LINKSTATE_PLAY = 5, Y_LINKSTATE_INVALID = -1 }
enum	Y_MUTE_enum {   Y_MUTE_FALSE = 0, Y_MUTE_TRUE = 1, Y_MUTE_INVALID = -1, Y_MUTE_FALSE = 0,   Y_MUTE_TRUE = 1, Y_MUTE_INVALID = -1, Y_MUTE_FALSE = 0, Y_MUTE_TRUE = 1,   Y_MUTE_INVALID = -1 }

Functions
YBluetoothLink *	yFindBluetoothLink (const string &func)
YBluetoothLink *	yFirstBluetoothLink (void)

Macro Definition Documentation

#define _Y_LINKSTATE_ENUM

Definition at line 64 of file yocto_bluetoothlink.h.

#define _Y_MUTE_ENUM

Definition at line 56 of file yocto_bluetoothlink.h.

#define Y_COMMAND_INVALID   (YAPI_INVALID_STRING)

Definition at line 82 of file yocto_bluetoothlink.h.

#define Y_LINKQUALITY_INVALID   (YAPI_INVALID_UINT)

Definition at line 81 of file yocto_bluetoothlink.h.

#define Y_OWNADDRESS_INVALID   (YAPI_INVALID_STRING)

Definition at line 75 of file yocto_bluetoothlink.h.

#define Y_PAIRINGPIN_INVALID   (YAPI_INVALID_STRING)

Definition at line 76 of file yocto_bluetoothlink.h.

#define Y_PREAMPLIFIER_INVALID   (YAPI_INVALID_UINT)

Definition at line 79 of file yocto_bluetoothlink.h.

#define Y_REMOTEADDRESS_INVALID   (YAPI_INVALID_STRING)

Definition at line 77 of file yocto_bluetoothlink.h.

#define Y_REMOTENAME_INVALID   (YAPI_INVALID_STRING)

Definition at line 78 of file yocto_bluetoothlink.h.

#define Y_VOLUME_INVALID   (YAPI_INVALID_UINT)

Definition at line 80 of file yocto_bluetoothlink.h.

Typedef Documentation

typedef void(* YBluetoothLinkValueCallback) (YBluetoothLink *func, const string &functionValue)

Definition at line 54 of file yocto_bluetoothlink.h.

Enumeration Type Documentation

enum Y_LINKSTATE_enum

Enumerator
Y_LINKSTATE_DOWN
Y_LINKSTATE_FREE
Y_LINKSTATE_SEARCH
Y_LINKSTATE_EXISTS
Y_LINKSTATE_LINKED
Y_LINKSTATE_PLAY
Y_LINKSTATE_INVALID

Definition at line 65 of file yocto_bluetoothlink.h.

enum Y_MUTE_enum

Enumerator
Y_MUTE_FALSE
Y_MUTE_TRUE
Y_MUTE_INVALID
Y_MUTE_FALSE
Y_MUTE_TRUE
Y_MUTE_INVALID
Y_MUTE_FALSE
Y_MUTE_TRUE
Y_MUTE_INVALID

Definition at line 57 of file yocto_bluetoothlink.h.

Function Documentation

YBluetoothLink* yFindBluetoothLink ( const string &  func )

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 YBluetoothLink.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 YBluetoothLink object allowing you to drive the cellular interface.

Definition at line 462 of file yocto_bluetoothlink.h.

YBluetoothLink* yFirstBluetoothLink ( void  )

inline

Starts the enumeration of cellular interfaces currently accessible. Use the method YBluetoothLink.nextBluetoothLink() to iterate on next cellular interfaces.

Returns

a pointer to a YBluetoothLink object, corresponding to the first cellular interface currently online, or a NULL pointer if there are none.

Definition at line 473 of file yocto_bluetoothlink.h.