Open Lighting Architecture
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Types | Public Member Functions | List of all members
ola::rdm::DiscoveryAgent Class Reference

Detailed Description

This class controls the discovery algorithm.

Classes

struct  UIDRange

Public Types

typedef
ola::SingleUseCallback2< void,
bool, const UIDSet & > 
DiscoveryCompleteCallback

Public Member Functions

 DiscoveryAgent (DiscoveryTargetInterface *target)
 ~DiscoveryAgent ()
void Abort ()
void StartFullDiscovery (DiscoveryCompleteCallback *on_complete)
void StartIncrementalDiscovery (DiscoveryCompleteCallback *on_complete)

Constructor & Destructor Documentation

ola::rdm::DiscoveryAgent::DiscoveryAgent ( DiscoveryTargetInterface target)
explicit

Create a new DiscoveryAgent

Parameters
targetthe DiscoveryTargetInterface to use for sending messages.
ola::rdm::DiscoveryAgent::~DiscoveryAgent ( )

Clean up

Member Function Documentation

void ola::rdm::DiscoveryAgent::Abort ( )

Cancel the running discovery

void ola::rdm::DiscoveryAgent::StartFullDiscovery ( DiscoveryCompleteCallback on_complete)

Initiate full discovery

Parameters
on_completethe callback to run once discovery completes.
void ola::rdm::DiscoveryAgent::StartIncrementalDiscovery ( DiscoveryCompleteCallback on_complete)

Initiate incremental discovery

Parameters
on_completethe callback to run once discovery completes.

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