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

A topic manager manages topics, and subscribers to topics. More...

#include <IceStorm/IceStorm.h>

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

Public Member Functions

::std::shared_ptr< TopicPrxcreate (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext)
 Create a new topic. More...
 
::std::function< void()> createAsync (const ::std::string &name, ::std::function< void(::std::shared_ptr<::IceStorm::TopicPrx >)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Create a new topic. More...
 
template<template< typename > class P = ::std::promise>
auto createAsync (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::std::shared_ptr<::IceStorm::TopicPrx >>>().get_future())
 Create a new topic. More...
 
::Ice::SliceChecksumDict getSliceChecksums (const ::Ice::Context &context=::Ice::noExplicitContext)
 Returns the checksums for the IceStorm Slice definitions. More...
 
::std::function< void()> getSliceChecksumsAsync (::std::function< void(::Ice::SliceChecksumDict)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Returns the checksums for the IceStorm Slice definitions. More...
 
template<template< typename > class P = ::std::promise>
auto getSliceChecksumsAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::Ice::SliceChecksumDict >>().get_future())
 Returns the checksums for the IceStorm Slice definitions. More...
 
::std::shared_ptr< TopicPrxretrieve (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext)
 Retrieve a topic by name. More...
 
TopicDict retrieveAll (const ::Ice::Context &context=::Ice::noExplicitContext)
 Retrieve all topics managed by this topic manager. More...
 
::std::function< void()> retrieveAllAsync (::std::function< void(::IceStorm::TopicDict)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Retrieve all topics managed by this topic manager. More...
 
template<template< typename > class P = ::std::promise>
auto retrieveAllAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::IceStorm::TopicDict >>().get_future())
 Retrieve all topics managed by this topic manager. More...
 
::std::function< void()> retrieveAsync (const ::std::string &name, ::std::function< void(::std::shared_ptr<::IceStorm::TopicPrx >)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Retrieve a topic by name. More...
 
template<template< typename > class P = ::std::promise>
auto retrieveAsync (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::std::shared_ptr<::IceStorm::TopicPrx >>>().get_future())
 Retrieve a topic by name. More...
 
- Public Member Functions inherited from Ice::Proxy< TopicManagerPrx, ::Ice::ObjectPrx >
::std::shared_ptr< TopicManagerPrx > 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< TopicManagerPrx > ice_batchDatagram () const
 Obtains a proxy that is identical to this proxy, but uses batch datagram invocations. More...
 
::std::shared_ptr< TopicManagerPrx > ice_batchOneway () const
 Obtains a proxy that is identical to this proxy, but uses batch oneway invocations. More...
 
::std::shared_ptr< TopicManagerPrx > ice_collocationOptimized (bool b) const
 Obtains a proxy that is identical to this proxy, except for collocation optimization. More...
 
::std::shared_ptr< TopicManagerPrx > 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< TopicManagerPrx > ice_connectionCached (bool b) const
 Obtains a proxy that is identical to this proxy, except for connection caching. More...
 
::std::shared_ptr< TopicManagerPrx > 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< TopicManagerPrx > 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< TopicManagerPrx > ice_datagram () const
 Obtains a proxy that is identical to this proxy, but uses datagram invocations. More...
 
::std::shared_ptr< TopicManagerPrx > 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< TopicManagerPrx > ice_endpoints (const ::Ice::EndpointSeq &endpoints) const
 Obtains a proxy that is identical to this proxy, except for the endpoints. More...
 
::std::shared_ptr< TopicManagerPrx > 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< TopicManagerPrx > 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< TopicManagerPrx > ice_invocationTimeout (int timeout) const
 Obtains a proxy that is identical to this proxy, except for the invocation timeout. More...
 
::std::shared_ptr< TopicManagerPrx > 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< TopicManagerPrx > ice_locatorCacheTimeout (int timeout) const
 Obtains a proxy that is identical to this proxy, except for the locator cache timeout. More...
 
::std::shared_ptr< TopicManagerPrx > ice_oneway () const
 Obtains a proxy that is identical to this proxy, but uses oneway invocations. More...
 
::std::shared_ptr< TopicManagerPrx > ice_preferSecure (bool b) const
 Obtains a proxy that is identical to this proxy, except for its endpoint selection policy. More...
 
::std::shared_ptr< TopicManagerPrx > 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< TopicManagerPrx > ice_secure (bool b) const
 Obtains a proxy that is identical to this proxy, except for how it selects endpoints. More...
 
::std::shared_ptr< TopicManagerPrx > 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< TopicManagerPrx > 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

A topic manager manages topics, and subscribers to topics.

See also
Topic

Member Function Documentation

◆ create()

::std::shared_ptr<TopicPrx> IceStorm::TopicManagerPrx::create ( const ::std::string &  name,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Create a new topic.

The topic name must be unique.

Parameters
nameThe name of the topic.
contextThe Context map to send with the invocation.
Returns
A proxy to the topic instance.
Exceptions
IceStorm::TopicExistsRaised if a topic with the same name already exists.

◆ createAsync() [1/2]

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

Create a new topic.

The topic name must be unique.

Parameters
nameThe name of the 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.

◆ createAsync() [2/2]

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

Create a new topic.

The topic name must be unique.

Parameters
nameThe name of the topic.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ getSliceChecksums()

::Ice::SliceChecksumDict IceStorm::TopicManagerPrx::getSliceChecksums ( const ::Ice::Context context = ::Ice::noExplicitContext)
inline

Returns the checksums for the IceStorm Slice definitions.

Parameters
contextThe Context map to send with the invocation.
Returns
A dictionary mapping Slice type ids to their checksums.

◆ getSliceChecksumsAsync() [1/2]

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

Returns the checksums for the IceStorm Slice definitions.

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.

◆ getSliceChecksumsAsync() [2/2]

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

Returns the checksums for the IceStorm Slice definitions.

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

◆ ice_staticId()

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

Obtains the Slice type ID of this interface.

Returns
The fully-scoped type ID.

◆ retrieve()

::std::shared_ptr<TopicPrx> IceStorm::TopicManagerPrx::retrieve ( const ::std::string &  name,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Retrieve a topic by name.

Parameters
nameThe name of the topic.
contextThe Context map to send with the invocation.
Returns
A proxy to the topic instance.
Exceptions
IceStorm::NoSuchTopicRaised if the topic does not exist.

◆ retrieveAll()

TopicDict IceStorm::TopicManagerPrx::retrieveAll ( const ::Ice::Context context = ::Ice::noExplicitContext)
inline

Retrieve all topics managed by this topic manager.

Parameters
contextThe Context map to send with the invocation.
Returns
A dictionary of string, topic proxy pairs.

◆ retrieveAllAsync() [1/2]

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

Retrieve all topics managed by this topic manager.

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.

◆ retrieveAllAsync() [2/2]

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

Retrieve all topics managed by this topic manager.

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

◆ retrieveAsync() [1/2]

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

Retrieve a topic by name.

Parameters
nameThe name of the 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.

◆ retrieveAsync() [2/2]

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

Retrieve a topic by name.

Parameters
nameThe name of the topic.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

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