Ice 3.7 C++11 API Reference
|
Publishers publish information on a particular topic. More...
#include <IceStorm/IceStorm.h>
Public Types | |
using | ProxyType = TopicPrx |
Public Member Functions | |
virtual void | destroy (const ::Ice::Current ¤t)=0 |
Destroy the topic. More... | |
virtual LinkInfoSeq | getLinkInfoSeq (const ::Ice::Current ¤t) const =0 |
Retrieve information on the current links. More... | |
virtual ::std::string | getName (const ::Ice::Current ¤t) const =0 |
Get the name of this topic. More... | |
virtual ::std::shared_ptr<::Ice::ObjectPrx > | getNonReplicatedPublisher (const ::Ice::Current ¤t) const =0 |
Get a non-replicated proxy to a publisher object for this topic. More... | |
virtual ::std::shared_ptr<::Ice::ObjectPrx > | getPublisher (const ::Ice::Current ¤t) const =0 |
Get a proxy to a publisher object for this topic. More... | |
virtual ::Ice::IdentitySeq | getSubscribers (const ::Ice::Current ¤t) const =0 |
Retrieve the list of subscribers for this topic. More... | |
virtual ::std::string | ice_id (const ::Ice::Current ¤t) const override |
Obtains a Slice type ID representing the most-derived interface supported by this object. More... | |
virtual ::std::vector<::std::string > | ice_ids (const ::Ice::Current ¤t) const override |
Obtains a list of the Slice type IDs representing the interfaces supported by this object. More... | |
virtual bool | ice_isA (::std::string id, const ::Ice::Current ¤t) const override |
Determines whether this object supports an interface with the given Slice type ID. More... | |
virtual void | link (::std::shared_ptr< TopicPrx > linkTo, int cost, const ::Ice::Current ¤t)=0 |
Create a link to the given topic. More... | |
virtual ::std::shared_ptr<::Ice::ObjectPrx > | subscribeAndGetPublisher (QoS theQoS, ::std::shared_ptr<::Ice::ObjectPrx > subscriber, const ::Ice::Current ¤t)=0 |
Subscribe with the given qos to this topic. More... | |
virtual void | unlink (::std::shared_ptr< TopicPrx > linkTo, const ::Ice::Current ¤t)=0 |
Destroy the link from this topic to the given topic linkTo . More... | |
virtual void | unsubscribe (::std::shared_ptr<::Ice::ObjectPrx > subscriber, const ::Ice::Current ¤t)=0 |
Unsubscribe the given subscriber . More... | |
Public Member Functions inherited from Ice::Object | |
virtual bool | ice_dispatch (Ice::Request &request, std::function< bool()> response=nullptr, std::function< bool(std::exception_ptr)> error=nullptr) |
Dispatches an invocation to a servant. More... | |
virtual std::string | ice_id (const Current ¤t) const |
Returns the Slice type ID of the most-derived interface supported by this object. More... | |
virtual std::vector< std::string > | ice_ids (const Current ¤t) const |
Returns the Slice type IDs of the interfaces supported by this object. More... | |
virtual bool | ice_isA (std::string s, const Current ¤t) const |
Tests whether this object supports a specific Slice interface. More... | |
virtual void | ice_ping (const Current ¤t) const |
Tests whether this object can be reached. More... | |
virtual | ~Object ()=default |
Static Public Member Functions | |
static const ::std::string & | ice_staticId () |
Obtains the Slice type ID corresponding to this class. More... | |
Static Public Member Functions inherited from Ice::Object | |
static const std::string & | ice_staticId () |
Obtains the Slice type ID of this type. More... | |
Publishers publish information on a particular topic.
A topic logically represents a type.
using IceStorm::Topic::ProxyType = TopicPrx |
|
pure virtual |
Destroy the topic.
current | The Current object for the invocation. |
|
pure virtual |
Retrieve information on the current links.
current | The Current object for the invocation. |
|
pure virtual |
Get the name of this topic.
current | The Current object for the invocation. |
|
pure virtual |
Get a non-replicated proxy to a publisher object for this topic.
To publish data to a topic, the publisher calls getPublisher and then casts to the topic type. An unchecked cast must be used on this proxy.
current | The Current object for the invocation. |
|
pure virtual |
Get a proxy to a publisher object for this topic.
To publish data to a topic, the publisher calls getPublisher and then casts to the topic type. An unchecked cast must be used on this proxy. If a replicated IceStorm deployment is used this call may return a replicated proxy.
current | The Current object for the invocation. |
|
pure virtual |
Retrieve the list of subscribers for this topic.
current | The Current object for the invocation. |
|
override |
Obtains a Slice type ID representing the most-derived interface supported by this object.
current | The Current object for the invocation. |
|
override |
Obtains a list of the Slice type IDs representing the interfaces supported by this object.
current | The Current object for the invocation. |
|
overridevirtual |
Determines whether this object supports an interface with the given Slice type ID.
id | The fully-scoped Slice type ID. |
current | The Current object for the invocation. |
|
static |
Obtains the Slice type ID corresponding to this class.
|
pure virtual |
Create a link to the given topic.
All events originating on this topic will also be sent to linkTo
.
linkTo | The topic to link to. |
cost | The cost to the linked topic. |
current | The Current object for the invocation. |
IceStorm::LinkExists | Raised if a link to the same topic already exists. |
|
pure virtual |
Subscribe with the given qos
to this topic.
A per-subscriber publisher object is returned.
theQoS | The quality of service parameters for this subscription. |
subscriber | The subscriber's proxy. |
current | The Current object for the invocation. |
IceStorm::AlreadySubscribed | Raised if the subscriber object is already subscribed. |
IceStorm::BadQoS | Raised if the requested quality of service is unavailable or invalid. |
IceStorm::InvalidSubscriber | Raised if the subscriber object is null. |
|
pure virtual |
Destroy the link from this topic to the given topic linkTo
.
linkTo | The topic to destroy the link to. |
current | The Current object for the invocation. |
IceStorm::NoSuchLink | Raised if a link to the topic does not exist. |
|
pure virtual |
Unsubscribe the given subscriber
.
subscriber | The proxy of an existing subscriber. |
current | The Current object for the invocation. |