|
| virtual void | publish (const std::string &address, const std::string &keyword)=0 |
| |
| virtual void | unpublish (const std::string &keyword)=0 |
| |
| virtual void | update (const std::string &keyword, const std::string &data)=0 |
| |
| virtual bool | hasSubscribers (const std::string &keyword) const =0 |
| |
| virtual bool | shutdown ()=0 |
| |
◆ hasSubscribers()
| virtual bool larcfm::Transmitter::hasSubscribers |
( |
const std::string & |
keyword | ) |
const |
|
pure virtual |
Returns true if there is at least one active subscriber associated with this keyword
- Parameters
-
- Returns
Implemented in larcfm::FilePushTransmitter.
◆ publish()
| virtual void larcfm::Transmitter::publish |
( |
const std::string & |
address, |
|
|
const std::string & |
keyword |
|
) |
| |
|
pure virtual |
Publisher announces it has data of type keyword.
- Parameters
-
| address | string representing the address to be listened to for subscribers (e.g. port) |
| keyword | Keywords should be cumulative for all data types presented |
Implemented in larcfm::FilePushTransmitter.
◆ shutdown()
| virtual bool larcfm::Transmitter::shutdown |
( |
| ) |
|
|
pure virtual |
Attempts to cleanly shuts down this transmitter, releasing any associated resources. This does not "unpublish" the transmitter.
- Returns
- true if shut down successfully.
Implemented in larcfm::FilePushTransmitter.
◆ unpublish()
| virtual void larcfm::Transmitter::unpublish |
( |
const std::string & |
keyword | ) |
|
|
pure virtual |
Publisher removes a certain keyword from its publishing list.
- Parameters
-
| keyword | Keywords to remove |
Implemented in larcfm::FilePushTransmitter.
◆ update()
| virtual void larcfm::Transmitter::update |
( |
const std::string & |
keyword, |
|
|
const std::string & |
data |
|
) |
| |
|
pure virtual |
Publisher updates data to be transmitted. Depending on the connection type, this may immediately push the data to all subscribers or cache it until requested.
- Parameters
-
| keyword | which keyword this data is associated with |
| data | |
Implemented in larcfm::FilePushTransmitter.
The documentation for this class was generated from the following file:
1.9.2
