Ice 3.8
C++ API Reference
Loading...
Searching...
No Matches
IceStorm::TopicPrx Class Reference

Represents an IceStorm topic. More...

#include <IceStorm/IceStorm.h>

Inheritance diagram for IceStorm::TopicPrx:

Public Member Functions

 TopicPrx (const Ice::CommunicatorPtr &communicator, std::string_view proxyString)
 Constructs a proxy from a Communicator and a proxy string.
 TopicPrx (const TopicPrx &other) noexcept
 Copy constructor.
 TopicPrx (TopicPrx &&other) noexcept
 Move constructor.
void destroy (const Ice::Context &context=Ice::noExplicitContext) const
 Destroys this topic.
std::future< void > destroyAsync (const Ice::Context &context=Ice::noExplicitContext) const
 Destroys this topic.
std::function< void()> destroyAsync (std::function< void()> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Destroys this topic.
LinkInfoSeq getLinkInfoSeq (const Ice::Context &context=Ice::noExplicitContext) const
 Gets information on the current links.
std::future< LinkInfoSeqgetLinkInfoSeqAsync (const Ice::Context &context=Ice::noExplicitContext) const
 Gets information on the current links.
std::function< void()> getLinkInfoSeqAsync (std::function< void(::IceStorm::LinkInfoSeq)> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Gets information on the current links.
std::string getName (const Ice::Context &context=Ice::noExplicitContext) const
 Gets the name of this topic.
std::future< std::string > getNameAsync (const Ice::Context &context=Ice::noExplicitContext) const
 Gets the name of this topic.
std::function< void()> getNameAsync (std::function< void(std::string)> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Gets the name of this topic.
std::optional< Ice::ObjectPrxgetNonReplicatedPublisher (const Ice::Context &context=Ice::noExplicitContext) const
 Gets a non-replicated proxy to a publisher object for this topic.
std::future< std::optional< Ice::ObjectPrx > > getNonReplicatedPublisherAsync (const Ice::Context &context=Ice::noExplicitContext) const
 Gets a non-replicated proxy to a publisher object for this topic.
std::function< void()> getNonReplicatedPublisherAsync (std::function< void(std::optional< Ice::ObjectPrx >)> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Gets a non-replicated proxy to a publisher object for this topic.
std::optional< Ice::ObjectPrxgetPublisher (const Ice::Context &context=Ice::noExplicitContext) const
 Gets a proxy to a publisher object for this topic.
std::future< std::optional< Ice::ObjectPrx > > getPublisherAsync (const Ice::Context &context=Ice::noExplicitContext) const
 Gets a proxy to a publisher object for this topic.
std::function< void()> getPublisherAsync (std::function< void(std::optional< Ice::ObjectPrx >)> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Gets a proxy to a publisher object for this topic.
::Ice::IdentitySeq getSubscribers (const Ice::Context &context=Ice::noExplicitContext) const
 Gets the list of subscribers for this topic.
std::future<::Ice::IdentitySeqgetSubscribersAsync (const Ice::Context &context=Ice::noExplicitContext) const
 Gets the list of subscribers for this topic.
std::function< void()> getSubscribersAsync (std::function< void(::Ice::IdentitySeq)> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Gets the list of subscribers for this topic.
void link (const std::optional< TopicPrx > &linkTo, std::int32_t cost, const Ice::Context &context=Ice::noExplicitContext) const
 Creates a link to another topic.
std::future< void > linkAsync (const std::optional< TopicPrx > &linkTo, std::int32_t cost, const Ice::Context &context=Ice::noExplicitContext) const
 Creates a link to another topic.
std::function< void()> linkAsync (const std::optional< TopicPrx > &linkTo, std::int32_t cost, std::function< void()> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Creates a link to another topic.
TopicPrxoperator= (const TopicPrx &rhs) noexcept
 Copy assignment operator.
TopicPrxoperator= (TopicPrx &&rhs) noexcept
 Move assignment operator.
std::optional< Ice::ObjectPrxsubscribeAndGetPublisher (const QoS &theQoS, const std::optional< Ice::ObjectPrx > &subscriber, const Ice::Context &context=Ice::noExplicitContext) const
 Subscribes to this topic.
std::future< std::optional< Ice::ObjectPrx > > subscribeAndGetPublisherAsync (const QoS &theQoS, const std::optional< Ice::ObjectPrx > &subscriber, const Ice::Context &context=Ice::noExplicitContext) const
 Subscribes to this topic.
std::function< void()> subscribeAndGetPublisherAsync (const QoS &theQoS, const std::optional< Ice::ObjectPrx > &subscriber, std::function< void(std::optional< Ice::ObjectPrx >)> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Subscribes to this topic.
void unlink (const std::optional< TopicPrx > &linkTo, const Ice::Context &context=Ice::noExplicitContext) const
 Destroys a link from this topic to the provided topic.
std::future< void > unlinkAsync (const std::optional< TopicPrx > &linkTo, const Ice::Context &context=Ice::noExplicitContext) const
 Destroys a link from this topic to the provided topic.
std::function< void()> unlinkAsync (const std::optional< TopicPrx > &linkTo, std::function< void()> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Destroys a link from this topic to the provided topic.
void unsubscribe (const std::optional< Ice::ObjectPrx > &subscriber, const Ice::Context &context=Ice::noExplicitContext) const
 Unsubscribes the provided subscriber from this topic.
std::future< void > unsubscribeAsync (const std::optional< Ice::ObjectPrx > &subscriber, const Ice::Context &context=Ice::noExplicitContext) const
 Unsubscribes the provided subscriber from this topic.
std::function< void()> unsubscribeAsync (const std::optional< Ice::ObjectPrx > &subscriber, std::function< void()> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Unsubscribes the provided subscriber from this topic.
Public Member Functions inherited from Ice::Proxy< TopicPrx, Ice::ObjectPrx >
TopicPrx ice_adapterId (std::string id) const
 Creates a proxy that is identical to this proxy, except for the adapter ID.
TopicPrx ice_batchDatagram () const
 Creates a proxy that is identical to this proxy, but uses batch datagram invocations.
TopicPrx ice_batchOneway () const
 Creates a proxy that is identical to this proxy, but uses batch oneway invocations.
TopicPrx ice_collocationOptimized (bool b) const
 Creates a proxy that is identical to this proxy, except for collocation optimization.
TopicPrx ice_compress (bool b) const
 Creates a proxy that is identical to this proxy, except for its compression setting which overrides the compression setting from the proxy endpoints.
TopicPrx ice_connectionCached (bool b) const
 Creates a proxy that is identical to this proxy, except for connection caching.
TopicPrx ice_connectionId (std::string id) const
 Creates a proxy that is identical to this proxy, except for its connection ID.
TopicPrx ice_context (Context context) const
 Creates a proxy that is identical to this proxy, except for the per-proxy context.
TopicPrx ice_datagram () const
 Creates a proxy that is identical to this proxy, but uses datagram invocations.
TopicPrx ice_encodingVersion (EncodingVersion version) const
 Creates a proxy that is identical to this proxy, except for the encoding used to marshal parameters.
TopicPrx ice_endpoints (EndpointSeq endpoints) const
 Creates a proxy that is identical to this proxy, except for the endpoints.
TopicPrx ice_endpointSelection (EndpointSelectionType type) const
 Creates a proxy that is identical to this proxy, except for the endpoint selection policy.
TopicPrx ice_fixed (ConnectionPtr connection) const
 Creates a proxy that is identical to this proxy, except it's a fixed proxy bound to the given connection.
TopicPrx ice_invocationTimeout (int timeout) const
 Creates a proxy that is identical to this proxy, except for the invocation timeout.
TopicPrx ice_locator (const std::optional< LocatorPrx > &locator) const
 Creates a proxy that is identical to this proxy, except for the locator.
TopicPrx ice_locatorCacheTimeout (int timeout) const
 Creates a proxy that is identical to this proxy, except for the locator cache timeout.
TopicPrx ice_oneway () const
 Creates a proxy that is identical to this proxy, but uses oneway invocations.
TopicPrx ice_router (const std::optional< RouterPrx > &router) const
 Creates a proxy that is identical to this proxy, except for the router.
TopicPrx ice_twoway () const
 Creates a proxy that is identical to this proxy, but uses twoway invocations.
const TopicPrx * operator-> () const noexcept
 The arrow operator.

Static Public Member Functions

static const char * ice_staticId () noexcept
 Gets the type ID of the associated Slice interface.

Detailed Description

Represents an IceStorm topic.

Publishers publish data to a topic (via the topic's publisher object), and subscribers subscribe to a topic.

See also
TopicManager

Definition at line 60 of file IceStorm.h.


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