Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Friends | List of all members
YOsControl Class Reference

#include <yocto_oscontrol.h>

Inheritance diagram for YOsControl:
Inheritance graph
[legend]

Public Member Functions

virtual int _invokeValueCallback (string value)
 
int get_shutdownCountdown (void)
 
YOsControl * next (void)
 
YOsControl * nextOsControl (void)
 
virtual int registerValueCallback (YOsControlValueCallback callback)
 
int set_shutdownCountdown (int newval)
 
int setShutdownCountdown (int newval)
 
virtual int shutdown (int secBeforeShutDown)
 
int shutdownCountdown (void)
 
 ~YOsControl ()
 
- Public Member Functions inherited from YFunction
void _clearDataStreamCache ()
 
string _decode_json_string (const string &json)
 
string _download (const string &url)
 
YDataStream * _findDataStream (YDataSet &dataset, const string &def)
 
string _get_json_path (const string &json, const string &path)
 
vector< string > _json_get_array (const string &json)
 
string _json_get_key (const string &json, const string &data)
 
string _json_get_string (const string &json)
 
int _parseEx (yJsonStateMachine &j)
 
virtual int _parserHelper (void)
 
string _parseString (yJsonStateMachine &j)
 
string _request (const string &request)
 
string _requestEx (int tcpchan, const string &request, yapiRequestProgressCallback callback, void *context)
 
void _throw (YRETCODE errType, string errMsg)
 
YRETCODE _upload (const string &path, const string &content)
 
YRETCODE _uploadWithProgress (const string &path, const string &content, yapiRequestProgressCallback callback, void *context)
 
string advertisedValue (void)
 
void clearCache ()
 
string describe (void)
 
string errMessage (void)
 
string errorMessage (void)
 
YRETCODE errorType (void)
 
YRETCODE errType (void)
 
YFUN_DESCR functionDescriptor (void)
 
string get_advertisedValue (void)
 
string get_errorMessage (void)
 
YRETCODE get_errorType (void)
 
virtual string get_friendlyName (void)
 
YFUN_DESCR get_functionDescriptor (void)
 
string get_functionId (void)
 
string get_hardwareId (void)
 
string get_hubSerial ()
 
string get_logicalName (void)
 
YModule * get_module (void)
 
void * get_userData (void)
 
bool isOnline (void)
 
YRETCODE load (int msValidity)
 
virtual string loadAttribute (string attrName)
 
string logicalName (void)
 
YModule * module (void)
 
virtual int muteValueCallbacks (void)
 
YFunction * next (void)
 
YFunction * nextFunction (void)
 
virtual int registerValueCallback (YFunctionValueCallback callback)
 
int set_advertisedValue (const string &newval)
 
int set_logicalName (const string &newval)
 
void set_userData (void *data)
 
int setAdvertisedValue (const string &newval)
 
int setLogicalName (const string &newval)
 
void setUserData (void *data)
 
virtual int unmuteValueCallbacks (void)
 
void * userData (void)
 
virtual ~YFunction ()
 

Static Public Member Functions

static YOsControl * Find (string func)
 
static YOsControl * FindOsControl (string func)
 
static YOsControl * First (void)
 
static YOsControl * FirstOsControl (void)
 
- Static Public Member Functions inherited from YFunction
static void _ClearCache (void)
 
static YFunction * Find (string func)
 
static YFunction * FindFunction (string func)
 
static YFunction * First (void)
 
static YFunction * FirstFunction (void)
 

Static Public Attributes

static const int SHUTDOWNCOUNTDOWN_INVALID = YAPI_INVALID_UINT
 
- Static Public Attributes inherited from YFunction
static const string ADVERTISEDVALUE_INVALID = YAPI_INVALID_STRING
 
static const string FRIENDLYNAME_INVALID = YAPI_INVALID_STRING
 
static const YFUN_DESCR FUNCTIONDESCRIPTOR_INVALID = Y_FUNCTIONDESCRIPTOR_INVALID
 
static const string FUNCTIONID_INVALID = YAPI_INVALID_STRING
 
static const string HARDWAREID_INVALID = YAPI_INVALID_STRING
 
static const string LOGICALNAME_INVALID = YAPI_INVALID_STRING
 

Protected Member Functions

virtual int _parseAttr (YJSONObject *json_val)
 
 YOsControl (const string &func)
 
- Protected Member Functions inherited from YFunction
YRETCODE _buildSetRequest (const string &changeattr, const string *changeval, string &request, string &errmsg)
 
string _escapeAttr (const string &changeval)
 
YRETCODE _getDescriptor (YFUN_DESCR &fundescr, string &errMsg)
 
YRETCODE _getDevice (YDevice *&dev, string &errMsg)
 
YRETCODE _load_unsafe (int msValidity)
 
YRETCODE _nextFunction (string &hwId)
 
int _parse (YJSONObject *j)
 
YRETCODE _setAttr (string attrname, string newvalue)
 
 YFunction (const string &func)
 

Protected Attributes

int _shutdownCountdown
 
YOsControlValueCallback _valueCallbackOsControl
 
- Protected Attributes inherited from YFunction
string _advertisedValue
 
u64 _cacheExpiration
 
string _className
 
std::map< string, YDataStream * > _dataStreams
 
string _func
 
YFUN_DESCR _fundescr
 
string _funId
 
string _hwId
 
string _lastErrorMsg
 
YRETCODE _lastErrorType
 
string _logicalName
 
string _serial
 
yCRITICAL_SECTION _this_cs
 
void * _userData
 
YFunctionValueCallback _valueCallbackFunction
 

Friends

YOsControl * yFindOsControl (const string &func)
 
YOsControl * yFirstOsControl (void)
 

Additional Inherited Members

- Static Protected Member Functions inherited from YFunction
static void _AddToCache (const string &classname, const string &func, YFunction *obj)
 
static YFunction * _FindFromCache (const string &classname, const string &func)
 
static void _UpdateTimedReportCallbackList (YFunction *func, bool add)
 
static void _UpdateValueCallbackList (YFunction *func, bool add)
 
- Static Protected Attributes inherited from YFunction
static std::map< string, YFunction * > _cache
 

Detailed Description

YOsControl Class: OS control

The OScontrol object allows some control over the operating system running a VirtualHub. OsControl is available on the VirtualHub software only. This feature must be activated at the VirtualHub start up with -o option.

Definition at line 66 of file yocto_oscontrol.h.

Constructor & Destructor Documentation

YOsControl::YOsControl ( const string &  func)
protected

Definition at line 51 of file yocto_oscontrol.cpp.

YOsControl::~YOsControl ( )

Definition at line 60 of file yocto_oscontrol.cpp.

Member Function Documentation

int YOsControl::_invokeValueCallback ( string  value)
virtual

Reimplemented from YFunction.

Definition at line 202 of file yocto_oscontrol.cpp.

int YOsControl::_parseAttr ( YJSONObject *  json_val)
protectedvirtual

Reimplemented from YFunction.

Definition at line 68 of file yocto_oscontrol.cpp.

static YOsControl* YOsControl::Find ( string  func)
inlinestatic

Definition at line 168 of file yocto_oscontrol.h.

YOsControl * YOsControl::FindOsControl ( string  func)
static

Retrieves OS control 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 OS control is online at the time it is invoked. The returned object is nevertheless valid. Use the method YOsControl.isOnline() to test if the OS control is indeed online at a given time. In case of ambiguity when looking for OS control 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 OS control
Returns
a YOsControl object allowing you to drive the OS control.

Definition at line 151 of file yocto_oscontrol.cpp.

static YOsControl* YOsControl::First ( void  )
inlinestatic

Definition at line 192 of file yocto_oscontrol.h.

YOsControl * YOsControl::FirstOsControl ( void  )
static

Starts the enumeration of OS control currently accessible. Use the method YOsControl.nextOsControl() to iterate on next OS control.

Returns
a pointer to a YOsControl object, corresponding to the first OS control currently online, or a NULL pointer if there are none.

Definition at line 236 of file yocto_oscontrol.cpp.

int YOsControl::get_shutdownCountdown ( void  )

Returns the remaining number of seconds before the OS shutdown, or zero when no shutdown has been scheduled.

Returns
an integer corresponding to the remaining number of seconds before the OS shutdown, or zero when no shutdown has been scheduled

On failure, throws an exception or returns Y_SHUTDOWNCOUNTDOWN_INVALID.

Definition at line 86 of file yocto_oscontrol.cpp.

YOsControl* YOsControl::next ( void  )
inline

Definition at line 179 of file yocto_oscontrol.h.

YOsControl * YOsControl::nextOsControl ( void  )

Continues the enumeration of OS control started using yFirstOsControl().

Returns
a pointer to a YOsControl object, corresponding to OS control currently online, or a NULL pointer if there are no more OS control to enumerate.

Definition at line 226 of file yocto_oscontrol.cpp.

int YOsControl::registerValueCallback ( YOsControlValueCallback  callback)
virtual

Registers the callback function that is invoked on every change of advertised value. The callback is invoked only during the execution of ySleep or yHandleEvents. This provides control over the time when the callback is triggered. For good responsiveness, remember to call one of these two functions periodically. To unregister a callback, pass a NULL pointer as argument.

Parameters
callback: the callback function to call, or a NULL pointer. The callback function should take two arguments: the function object of which the value has changed, and the character string describing the new advertised value.

Definition at line 183 of file yocto_oscontrol.cpp.

int YOsControl::set_shutdownCountdown ( int  newval)

Definition at line 108 of file yocto_oscontrol.cpp.

int YOsControl::setShutdownCountdown ( int  newval)
inline

Definition at line 108 of file yocto_oscontrol.h.

int YOsControl::shutdown ( int  secBeforeShutDown)
virtual

Schedules an OS shutdown after a given number of seconds.

Parameters
secBeforeShutDown: number of seconds before shutdown
Returns
YAPI_SUCCESS when the call succeeds.

On failure, throws an exception or returns a negative error code.

Definition at line 221 of file yocto_oscontrol.cpp.

int YOsControl::shutdownCountdown ( void  )
inline

Definition at line 104 of file yocto_oscontrol.h.

Friends And Related Function Documentation

YOsControl* yFindOsControl ( const string &  func)
friend

Retrieves OS control 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 OS control is online at the time it is invoked. The returned object is nevertheless valid. Use the method YOsControl.isOnline() to test if the OS control is indeed online at a given time. In case of ambiguity when looking for OS control 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 OS control
Returns
a YOsControl object allowing you to drive the OS control.

Definition at line 229 of file yocto_oscontrol.h.

YOsControl* yFirstOsControl ( void  )
friend

Starts the enumeration of OS control currently accessible. Use the method YOsControl.nextOsControl() to iterate on next OS control.

Returns
a pointer to a YOsControl object, corresponding to the first OS control currently online, or a NULL pointer if there are none.

Definition at line 240 of file yocto_oscontrol.h.

Member Data Documentation

int YOsControl::_shutdownCountdown
protected

Definition at line 74 of file yocto_oscontrol.h.

YOsControlValueCallback YOsControl::_valueCallbackOsControl
protected

Definition at line 75 of file yocto_oscontrol.h.

const int YOsControl::SHUTDOWNCOUNTDOWN_INVALID = YAPI_INVALID_UINT
static

Definition at line 91 of file yocto_oscontrol.h.

The documentation for this class was generated from the following files:

yoctopuce_altimeter
Author(s): Anja Sheppard
autogenerated on Mon Jun 10 2019 15:49:13