nc::SimpleSupplier

nc::SimpleSupplier −

#include <acsncSimpleSupplier.h>

Inherits nc::Supplier.

Classes

class EventProcessingCallback

Public Member Functions

SimpleSupplier (const char *channelName, acscomponent::ACSComponentImpl *component, const char *acsNCDomainName=0)

template<class T > void publishData (T data, EventProcessingCallback< T > *evProcCallback=NULL)

Protected Member Functions

virtual ~SimpleSupplier ()

Protected Attributes

CORBA::Any any_m

Private Member Functions

void operator= (const SimpleSupplier &)

SimpleSupplier is used to publish data onto a notification channel defined by the string passed to SimpleSupplier’s constructor. To publish data onto the channel, simply invoke the publishData method on the templated type. This particular class blocks until the event is received on manager’s host and supports just about any number of event types for the channel it is connected to.

TODO:

•

nc::SimpleSupplier::SimpleSupplier (const char * channelName, acscomponent::ACSComponentImpl * component, const char * acsNCDomainName = 0) Constructor. All the work is done in the superclass’s constructor.

Parameters:

channelName The name of the channel events will be published to.
component A reference to a component is needed for the Event Description (which is normally hidden from Consumers).
acsNCDomain name of the ACS NC domain name. This is an optional parameter. It will default to acscommon::NAMESERVICE_BINDING_NC_DOMAIN_DEFAULT if it is not specified.

virtual nc::SimpleSupplier::~SimpleSupplier () [protected, virtual] Destructor is protected.

void nc::SimpleSupplier::operator= (const SimpleSupplier &) [private] ALMA C++ coding standards state copy operators should be disabled.

template<class T > void nc::SimpleSupplier::publishData (T data, EventProcessingCallback< T > * evProcCallback = NULL) publishData is the templated method that actually sends the event to the channel. The templated parameter is the ICD event (i.e., IDL struct) to be sent. Really this is the only Supplier method developers should be invoking from their code.

Parameters:

data The templated data structure to be published.
evProcCallback Pointer to the callback to handle event’s fate, by default is null

Exceptions:

ACSErrTypeCommon::CORBAProblemExImpl
acsncErrType::PublishEventFailureExImpl

CORBA::Any nc::SimpleSupplier::any_m [protected] CORBA Any taken out of the publishData method for a small performance increase.

Generated automatically by Doxygen for ACS-2015.2 C++ API from the source code.