Ice 3.7 C++11 API Reference
Public Member Functions | Static Public Member Functions | List of all members
IceStorm::TopicPrx Class Reference

Publishers publish information on a particular topic. More...

#include <IceStorm/IceStorm.h>

Inheritance diagram for IceStorm::TopicPrx:
Inheritance graph
[legend]
Collaboration diagram for IceStorm::TopicPrx:
Collaboration graph
[legend]

Public Member Functions

void destroy (const ::Ice::Context &context=::Ice::noExplicitContext)
 Destroy the topic. More...
 
::std::function< void()> destroyAsync (::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Destroy the topic. More...
 
template<template< typename > class P = ::std::promise>
auto destroyAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
 Destroy the topic. More...
 
LinkInfoSeq getLinkInfoSeq (const ::Ice::Context &context=::Ice::noExplicitContext)
 Retrieve information on the current links. More...
 
::std::function< void()> getLinkInfoSeqAsync (::std::function< void(::IceStorm::LinkInfoSeq)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Retrieve information on the current links. More...
 
template<template< typename > class P = ::std::promise>
auto getLinkInfoSeqAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::IceStorm::LinkInfoSeq >>().get_future())
 Retrieve information on the current links. More...
 
::std::string getName (const ::Ice::Context &context=::Ice::noExplicitContext)
 Get the name of this topic. More...
 
::std::function< void()> getNameAsync (::std::function< void(::std::string)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get the name of this topic. More...
 
template<template< typename > class P = ::std::promise>
auto getNameAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::std::string >>().get_future())
 Get the name of this topic. More...
 
::std::shared_ptr<::Ice::ObjectPrxgetNonReplicatedPublisher (const ::Ice::Context &context=::Ice::noExplicitContext)
 Get a non-replicated proxy to a publisher object for this topic. More...
 
::std::function< void()> getNonReplicatedPublisherAsync (::std::function< void(::std::shared_ptr<::Ice::ObjectPrx >)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get a non-replicated proxy to a publisher object for this topic. More...
 
template<template< typename > class P = ::std::promise>
auto getNonReplicatedPublisherAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::std::shared_ptr<::Ice::ObjectPrx >>>().get_future())
 Get a non-replicated proxy to a publisher object for this topic. More...
 
::std::shared_ptr<::Ice::ObjectPrxgetPublisher (const ::Ice::Context &context=::Ice::noExplicitContext)
 Get a proxy to a publisher object for this topic. More...
 
::std::function< void()> getPublisherAsync (::std::function< void(::std::shared_ptr<::Ice::ObjectPrx >)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get a proxy to a publisher object for this topic. More...
 
template<template< typename > class P = ::std::promise>
auto getPublisherAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::std::shared_ptr<::Ice::ObjectPrx >>>().get_future())
 Get a proxy to a publisher object for this topic. More...
 
::Ice::IdentitySeq getSubscribers (const ::Ice::Context &context=::Ice::noExplicitContext)
 Retrieve the list of subscribers for this topic. More...
 
::std::function< void()> getSubscribersAsync (::std::function< void(::Ice::IdentitySeq)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Retrieve the list of subscribers for this topic. More...
 
template<template< typename > class P = ::std::promise>
auto getSubscribersAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::Ice::IdentitySeq >>().get_future())
 Retrieve the list of subscribers for this topic. More...
 
void link (const ::std::shared_ptr< TopicPrx > &linkTo, int cost, const ::Ice::Context &context=::Ice::noExplicitContext)
 Create a link to the given topic. More...
 
::std::function< void()> linkAsync (const ::std::shared_ptr< TopicPrx > &linkTo, int cost, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Create a link to the given topic. More...
 
template<template< typename > class P = ::std::promise>
auto linkAsync (const ::std::shared_ptr< TopicPrx > &linkTo, int cost, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
 Create a link to the given topic. More...
 
::std::shared_ptr<::Ice::ObjectPrxsubscribeAndGetPublisher (const QoS &theQoS, const ::std::shared_ptr<::Ice::ObjectPrx > &subscriber, const ::Ice::Context &context=::Ice::noExplicitContext)
 Subscribe with the given qos to this topic. More...
 
::std::function< void()> subscribeAndGetPublisherAsync (const QoS &theQoS, const ::std::shared_ptr<::Ice::ObjectPrx > &subscriber, ::std::function< void(::std::shared_ptr<::Ice::ObjectPrx >)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Subscribe with the given qos to this topic. More...
 
template<template< typename > class P = ::std::promise>
auto subscribeAndGetPublisherAsync (const QoS &theQoS, const ::std::shared_ptr<::Ice::ObjectPrx > &subscriber, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::std::shared_ptr<::Ice::ObjectPrx >>>().get_future())
 Subscribe with the given qos to this topic. More...
 
void unlink (const ::std::shared_ptr< TopicPrx > &linkTo, const ::Ice::Context &context=::Ice::noExplicitContext)
 Destroy the link from this topic to the given topic linkTo. More...
 
::std::function< void()> unlinkAsync (const ::std::shared_ptr< TopicPrx > &linkTo, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Destroy the link from this topic to the given topic linkTo. More...
 
template<template< typename > class P = ::std::promise>
auto unlinkAsync (const ::std::shared_ptr< TopicPrx > &linkTo, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
 Destroy the link from this topic to the given topic linkTo. More...
 
void unsubscribe (const ::std::shared_ptr<::Ice::ObjectPrx > &subscriber, const ::Ice::Context &context=::Ice::noExplicitContext)
 Unsubscribe the given subscriber. More...
 
::std::function< void()> unsubscribeAsync (const ::std::shared_ptr<::Ice::ObjectPrx > &subscriber, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Unsubscribe the given subscriber. More...
 
template<template< typename > class P = ::std::promise>
auto unsubscribeAsync (const ::std::shared_ptr<::Ice::ObjectPrx > &subscriber, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
 Unsubscribe the given subscriber. More...
 
- Public Member Functions inherited from Ice::Proxy< TopicPrx, ::Ice::ObjectPrx >
::std::shared_ptr< TopicPrx > ice_adapterId (const ::std::string &id) const
 Obtains a proxy that is identical to this proxy, except for the adapter ID. More...
 
::std::shared_ptr< TopicPrx > ice_batchDatagram () const
 Obtains a proxy that is identical to this proxy, but uses batch datagram invocations. More...
 
::std::shared_ptr< TopicPrx > ice_batchOneway () const
 Obtains a proxy that is identical to this proxy, but uses batch oneway invocations. More...
 
::std::shared_ptr< TopicPrx > ice_collocationOptimized (bool b) const
 Obtains a proxy that is identical to this proxy, except for collocation optimization. More...
 
::std::shared_ptr< TopicPrx > ice_compress (bool b) const
 Obtains a proxy that is identical to this proxy, except for its compression setting which overrides the compression setting from the proxy endpoints. More...
 
::std::shared_ptr< TopicPrx > ice_connectionCached (bool b) const
 Obtains a proxy that is identical to this proxy, except for connection caching. More...
 
::std::shared_ptr< TopicPrx > ice_connectionId (const ::std::string &id) const
 Obtains a proxy that is identical to this proxy, except for its connection ID. More...
 
::std::shared_ptr< TopicPrx > ice_context (const ::Ice::Context &context) const
 Obtains a proxy that is identical to this proxy, except for the per-proxy context. More...
 
::std::shared_ptr< TopicPrx > ice_datagram () const
 Obtains a proxy that is identical to this proxy, but uses datagram invocations. More...
 
::std::shared_ptr< TopicPrx > ice_encodingVersion (const ::Ice::EncodingVersion &version) const
 Obtains a proxy that is identical to this proxy, except for the encoding used to marshal parameters. More...
 
::std::shared_ptr< TopicPrx > ice_endpoints (const ::Ice::EndpointSeq &endpoints) const
 Obtains a proxy that is identical to this proxy, except for the endpoints. More...
 
::std::shared_ptr< TopicPrx > ice_endpointSelection (::Ice::EndpointSelectionType type) const
 Obtains a proxy that is identical to this proxy, except for the endpoint selection policy. More...
 
::std::shared_ptr< TopicPrx > ice_fixed (const ::std::shared_ptr<::Ice::Connection > &connection) const
 Obtains a proxy that is identical to this proxy, except it's a fixed proxy bound the given connection. More...
 
::std::shared_ptr< TopicPrx > ice_invocationTimeout (int timeout) const
 Obtains a proxy that is identical to this proxy, except for the invocation timeout. More...
 
::std::shared_ptr< TopicPrx > ice_locator (const ::std::shared_ptr<::Ice::LocatorPrx > &locator) const
 Obtains a proxy that is identical to this proxy, except for the locator. More...
 
::std::shared_ptr< TopicPrx > ice_locatorCacheTimeout (int timeout) const
 Obtains a proxy that is identical to this proxy, except for the locator cache timeout. More...
 
::std::shared_ptr< TopicPrx > ice_oneway () const
 Obtains a proxy that is identical to this proxy, but uses oneway invocations. More...
 
::std::shared_ptr< TopicPrx > ice_preferSecure (bool b) const
 Obtains a proxy that is identical to this proxy, except for its endpoint selection policy. More...
 
::std::shared_ptr< TopicPrx > ice_router (const ::std::shared_ptr<::Ice::RouterPrx > &router) const
 Obtains a proxy that is identical to this proxy, except for the router. More...
 
::std::shared_ptr< TopicPrx > ice_secure (bool b) const
 Obtains a proxy that is identical to this proxy, except for how it selects endpoints. More...
 
::std::shared_ptr< TopicPrx > ice_timeout (int timeout) const
 Obtains a proxy that is identical to this proxy, except for its connection timeout setting which overrides the timeot setting from the proxy endpoints. More...
 
::std::shared_ptr< TopicPrx > ice_twoway () const
 Obtains a proxy that is identical to this proxy, but uses twoway invocations. More...
 

Static Public Member Functions

static const ::std::string & ice_staticId ()
 Obtains the Slice type ID of this interface. More...
 

Detailed Description

Publishers publish information on a particular topic.

A topic logically represents a type.

See also
TopicManager

Member Function Documentation

◆ destroy()

void IceStorm::TopicPrx::destroy ( const ::Ice::Context context = ::Ice::noExplicitContext)
inline

Destroy the topic.

Parameters
contextThe Context map to send with the invocation.

◆ destroyAsync() [1/2]

::std::function<void()> IceStorm::TopicPrx::destroyAsync ( ::std::function< void()>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Destroy the topic.

Parameters
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ destroyAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceStorm::TopicPrx::destroyAsync ( const ::Ice::Context context = ::Ice::noExplicitContext) -> decltype(::std::declval<P<void>>().get_future())
inline

Destroy the topic.

Parameters
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ getLinkInfoSeq()

LinkInfoSeq IceStorm::TopicPrx::getLinkInfoSeq ( const ::Ice::Context context = ::Ice::noExplicitContext)
inline

Retrieve information on the current links.

Parameters
contextThe Context map to send with the invocation.
Returns
A sequence of LinkInfo objects.

◆ getLinkInfoSeqAsync() [1/2]

::std::function<void()> IceStorm::TopicPrx::getLinkInfoSeqAsync ( ::std::function< void(::IceStorm::LinkInfoSeq)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Retrieve information on the current links.

Parameters
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ getLinkInfoSeqAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceStorm::TopicPrx::getLinkInfoSeqAsync ( const ::Ice::Context context = ::Ice::noExplicitContext) -> decltype(::std::declval<P<::IceStorm::LinkInfoSeq>>().get_future())
inline

Retrieve information on the current links.

Parameters
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ getName()

::std::string IceStorm::TopicPrx::getName ( const ::Ice::Context context = ::Ice::noExplicitContext)
inline

Get the name of this topic.

Parameters
contextThe Context map to send with the invocation.
Returns
The name of the topic.
See also
TopicManager::create

◆ getNameAsync() [1/2]

::std::function<void()> IceStorm::TopicPrx::getNameAsync ( ::std::function< void(::std::string)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get the name of this topic.

Parameters
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.
See also
TopicManager::create

◆ getNameAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceStorm::TopicPrx::getNameAsync ( const ::Ice::Context context = ::Ice::noExplicitContext) -> decltype(::std::declval<P<::std::string>>().get_future())
inline

Get the name of this topic.

Parameters
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.
See also
TopicManager::create

◆ getNonReplicatedPublisher()

::std::shared_ptr<::Ice::ObjectPrx> IceStorm::TopicPrx::getNonReplicatedPublisher ( const ::Ice::Context context = ::Ice::noExplicitContext)
inline

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.

Parameters
contextThe Context map to send with the invocation.
Returns
A proxy to publish data on this topic.

◆ getNonReplicatedPublisherAsync() [1/2]

::std::function<void()> IceStorm::TopicPrx::getNonReplicatedPublisherAsync ( ::std::function< void(::std::shared_ptr<::Ice::ObjectPrx >)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

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.

Parameters
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ getNonReplicatedPublisherAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceStorm::TopicPrx::getNonReplicatedPublisherAsync ( const ::Ice::Context context = ::Ice::noExplicitContext) -> decltype(::std::declval<P<::std::shared_ptr<::Ice::ObjectPrx>>>().get_future())
inline

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.

Parameters
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ getPublisher()

::std::shared_ptr<::Ice::ObjectPrx> IceStorm::TopicPrx::getPublisher ( const ::Ice::Context context = ::Ice::noExplicitContext)
inline

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.

Parameters
contextThe Context map to send with the invocation.
Returns
A proxy to publish data on this topic.

◆ getPublisherAsync() [1/2]

::std::function<void()> IceStorm::TopicPrx::getPublisherAsync ( ::std::function< void(::std::shared_ptr<::Ice::ObjectPrx >)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

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.

Parameters
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ getPublisherAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceStorm::TopicPrx::getPublisherAsync ( const ::Ice::Context context = ::Ice::noExplicitContext) -> decltype(::std::declval<P<::std::shared_ptr<::Ice::ObjectPrx>>>().get_future())
inline

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.

Parameters
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ getSubscribers()

::Ice::IdentitySeq IceStorm::TopicPrx::getSubscribers ( const ::Ice::Context context = ::Ice::noExplicitContext)
inline

Retrieve the list of subscribers for this topic.

Parameters
contextThe Context map to send with the invocation.
Returns
The sequence of Ice identities for the subscriber objects.

◆ getSubscribersAsync() [1/2]

::std::function<void()> IceStorm::TopicPrx::getSubscribersAsync ( ::std::function< void(::Ice::IdentitySeq)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Retrieve the list of subscribers for this topic.

Parameters
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ getSubscribersAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceStorm::TopicPrx::getSubscribersAsync ( const ::Ice::Context context = ::Ice::noExplicitContext) -> decltype(::std::declval<P<::Ice::IdentitySeq>>().get_future())
inline

Retrieve the list of subscribers for this topic.

Parameters
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ ice_staticId()

static const ::std::string& IceStorm::TopicPrx::ice_staticId ( )
static

Obtains the Slice type ID of this interface.

Returns
The fully-scoped type ID.

◆ link()

void IceStorm::TopicPrx::link ( const ::std::shared_ptr< TopicPrx > &  linkTo,
int  cost,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Create a link to the given topic.

All events originating on this topic will also be sent to linkTo.

Parameters
linkToThe topic to link to.
costThe cost to the linked topic.
contextThe Context map to send with the invocation.
Exceptions
IceStorm::LinkExistsRaised if a link to the same topic already exists.

◆ linkAsync() [1/2]

::std::function<void()> IceStorm::TopicPrx::linkAsync ( const ::std::shared_ptr< TopicPrx > &  linkTo,
int  cost,
::std::function< void()>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Create a link to the given topic.

All events originating on this topic will also be sent to linkTo.

Parameters
linkToThe topic to link to.
costThe cost to the linked topic.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ linkAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceStorm::TopicPrx::linkAsync ( const ::std::shared_ptr< TopicPrx > &  linkTo,
int  cost,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<void>>().get_future())
inline

Create a link to the given topic.

All events originating on this topic will also be sent to linkTo.

Parameters
linkToThe topic to link to.
costThe cost to the linked topic.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ subscribeAndGetPublisher()

::std::shared_ptr<::Ice::ObjectPrx> IceStorm::TopicPrx::subscribeAndGetPublisher ( const QoS theQoS,
const ::std::shared_ptr<::Ice::ObjectPrx > &  subscriber,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Subscribe with the given qos to this topic.

A per-subscriber publisher object is returned.

Parameters
theQoSThe quality of service parameters for this subscription.
subscriberThe subscriber's proxy.
contextThe Context map to send with the invocation.
Returns
The per-subscriber publisher object.
Exceptions
IceStorm::AlreadySubscribedRaised if the subscriber object is already subscribed.
IceStorm::BadQoSRaised if the requested quality of service is unavailable or invalid.
IceStorm::InvalidSubscriberRaised if the subscriber object is null.
See also
unsubscribe

◆ subscribeAndGetPublisherAsync() [1/2]

::std::function<void()> IceStorm::TopicPrx::subscribeAndGetPublisherAsync ( const QoS theQoS,
const ::std::shared_ptr<::Ice::ObjectPrx > &  subscriber,
::std::function< void(::std::shared_ptr<::Ice::ObjectPrx >)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Subscribe with the given qos to this topic.

A per-subscriber publisher object is returned.

Parameters
theQoSThe quality of service parameters for this subscription.
subscriberThe subscriber's proxy.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.
See also
unsubscribe

◆ subscribeAndGetPublisherAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceStorm::TopicPrx::subscribeAndGetPublisherAsync ( const QoS theQoS,
const ::std::shared_ptr<::Ice::ObjectPrx > &  subscriber,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<::std::shared_ptr<::Ice::ObjectPrx>>>().get_future())
inline

Subscribe with the given qos to this topic.

A per-subscriber publisher object is returned.

Parameters
theQoSThe quality of service parameters for this subscription.
subscriberThe subscriber's proxy.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.
See also
unsubscribe

◆ unlink()

void IceStorm::TopicPrx::unlink ( const ::std::shared_ptr< TopicPrx > &  linkTo,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Destroy the link from this topic to the given topic linkTo.

Parameters
linkToThe topic to destroy the link to.
contextThe Context map to send with the invocation.
Exceptions
IceStorm::NoSuchLinkRaised if a link to the topic does not exist.

◆ unlinkAsync() [1/2]

::std::function<void()> IceStorm::TopicPrx::unlinkAsync ( const ::std::shared_ptr< TopicPrx > &  linkTo,
::std::function< void()>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Destroy the link from this topic to the given topic linkTo.

Parameters
linkToThe topic to destroy the link to.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ unlinkAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceStorm::TopicPrx::unlinkAsync ( const ::std::shared_ptr< TopicPrx > &  linkTo,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<void>>().get_future())
inline

Destroy the link from this topic to the given topic linkTo.

Parameters
linkToThe topic to destroy the link to.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ unsubscribe()

void IceStorm::TopicPrx::unsubscribe ( const ::std::shared_ptr<::Ice::ObjectPrx > &  subscriber,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Unsubscribe the given subscriber.

Parameters
subscriberThe proxy of an existing subscriber.
contextThe Context map to send with the invocation.
See also
subscribeAndGetPublisher

◆ unsubscribeAsync() [1/2]

::std::function<void()> IceStorm::TopicPrx::unsubscribeAsync ( const ::std::shared_ptr<::Ice::ObjectPrx > &  subscriber,
::std::function< void()>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Unsubscribe the given subscriber.

Parameters
subscriberThe proxy of an existing subscriber.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.
See also
subscribeAndGetPublisher

◆ unsubscribeAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceStorm::TopicPrx::unsubscribeAsync ( const ::std::shared_ptr<::Ice::ObjectPrx > &  subscriber,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<void>>().get_future())
inline

Unsubscribe the given subscriber.

Parameters
subscriberThe proxy of an existing subscriber.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.
See also
subscribeAndGetPublisher

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