 |
Free Electron
|
|
Free Electron
|
Client Node interface to Beacon. More...
#include <BeaconClientStartupI.h>
Public Member Functions | |
| virtual bool | startup (const char *fileName)=0 |
| Startup Beacon Client from a configuration file. More... | |
 Public Member Functions inherited from beacon::BeaconClientI | |
| virtual bool | registerWithBeacon (const BeaconConfig &config, bool timeSync)=0 |
| Registers node with the Beacon. More... | |
| virtual void | shutdown ()=0 |
| Shutdowns the thread monitoring the Beacon and sending keep alive messages. More... | |
| virtual uint8_t | getID ()=0 |
| Returns the unique ID of this client instance. More... | |
| virtual int64_t | getTimeOffset ()=0 |
| Returns the time offset between the clock on the Beacon and the local processor. More... | |
| virtual int64_t | getBeaconTime ()=0 |
| Returns the current time plus the offset to give you the Beacon time. More... | |
| virtual int64_t | getLatency ()=0 |
| Returns the estimated latency between the server and the client. More... | |
| virtual bool | isListUpdated ()=0 |
| Returns true if the list has of nodes has changed. More... | |
| virtual void | getList (std::list< Node > ®isteredNode)=0 |
| Fills in the list of nodes registered with the Beacon. More... | |
| virtual bool | isBeaconAlive ()=0 |
| Returns true if the Beacon is alive (received a response from the Beacon within the timeout period) More... | |
| virtual bool | dictionaryGet (std::vector< std::pair< fe::String, fe::String >> &list)=0 |
| Global Dictionary access functions. More... | |
| virtual bool | dictionarySet (const std::vector< std::pair< fe::String, fe::String >> &list)=0 |
| Sets name/values in the Global Dictionary. More... | |
| virtual bool | dictionaryUnset (const std::vector< std::pair< fe::String, fe::String >> &list)=0 |
| Unsets name/value pairs in the Global Dictionary given a list of names. More... | |
| virtual bool | dictionaryClear ()=0 |
| Clears the Global Dictionary. More... | |
| virtual bool | dictionaryGetRegex (const fe::String searchString, std::vector< std::pair< fe::String, fe::String >> &list)=0 |
| Gets the all matching pairs in the Global Dictionary using the regex search string. More... | |
| virtual uint64_t | dictionaryGetUpdateCounter ()=0 |
| Get the last update counter received for the Global Dictionary. More... | |
| Public Member Functions inherited from fe::Component | |
| const String & | name (void) const |
| Return the components chosen name. More... | |
| const String | verboseName (void) const |
| Return the annotated chosen name. More... | |
| void | setName (const String &name) |
| Rename the component to anything you want. More... | |
| hp< Registry > | registry (void) const |
| Get the Registry that created this component. More... | |
| void | adjoin (sp< Component > spComponent) |
| Tie this component's lifetime to another. More... | |
| sp< Component > | create (const String &implementation, BWORD quiet=FALSE) const |
| Convienience function to registry()->create() More... | |
| void | disjoin (void) |
| Untie component from Hub, if connected. More... | |
| String | factoryName (void) |
| void | setLibrary (sp< Library > spLibrary) |
| Store a reference to the library used to instantiate this component. More... | |
| sp< Library > | library (void) |
| Get the library that created the component. More... | |
| void | setFactoryIndex (I32 a_factoryIndex) |
| Set the library's factory index. More... | |
| I32 | factoryIndex (void) |
| Get the library's factory index. More... | |
| void | setSingleton (BWORD set) |
| Specify whether component is a singleton. More... | |
| BWORD | isSingleton (void) |
| Return whether component is a singleton. More... | |
| virtual void | acquire (void) |
| Specialized reference increment. More... | |
| virtual void | release (void) |
| Specialized reference decrement. More... | |
| Public Member Functions inherited from fe::Handled< Component > | |
| const hp< Component > & | getHandle (void) const |
| Get a safe handle to this object. More... | |
| Public Member Functions inherited from fe::Protectable | |
| virtual I32 | protection (void) const |
| virtual void | protect (void) |
| virtual void | unprotect (void) |
| virtual Protectable * | clone (Protectable *pInstance=NULL) |
| Public Member Functions inherited from fe::Counted | |
| virtual void | acquire (int &rCount) |
| Increment the reference count (and get the count) More... | |
| virtual void | abandon (void) |
| Decrement the reference count. More... | |
| int | count (void) const |
| Return the count of references. More... | |
| void | setName (const String &) |
| void | trackReference (void *pReference, String what) |
| void | untrackReference (void *pReference) |
| void | registerRegion (void *pT, U32 bytes) |
| Public Member Functions inherited from fe::Initialized | |
| void | initializeAll (void) |
| void | setActive (bool a_active) |
Additional Inherited Members | |
| Static Public Member Functions inherited from fe::Counted | |
| static String | reportTracker (void) |
| static U32 | trackerCount (void) |
| Protected Types inherited from fe::Initialized | |
| typedef void(* | InitializeFunction) (Initialized *) |
| Protected Member Functions inherited from fe::Handled< Component > | |
| void | abandonHandle (void) |
| Protected Member Functions inherited from fe::Counted | |
| int | releaseInternal (void) |
| Decrement the reference count. More... | |
| void | suppressReport (void) |
| Protected Member Functions inherited from fe::Initialized | |
| void | addInitializer (InitializeFunction function) |
| Related Functions inherited from fe::Component | |
| FE_DL_EXPORT void FE_CDECL | checkUnload (sp< Library > &pLibrary, Component *pComponent=NULL) |
| Delete the component and unload libraries where appropriate. More... | |
Client Node interface to Beacon.
|
pure virtual |
Startup Beacon Client from a configuration file.
Implemented in beacon::BeaconClientStartup.
1.8.13