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

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

#include <IceStorm/IceStorm.h>

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

Public Types

using ProxyType = TopicManagerPrx
 

Public Member Functions

virtual ::std::shared_ptr< TopicPrxcreate (::std::string name, const ::Ice::Current &current)=0
 Create a new topic. More...
 
virtual ::Ice::SliceChecksumDict getSliceChecksums (const ::Ice::Current &current) const =0
 Returns the checksums for the IceStorm Slice definitions. More...
 
virtual ::std::string ice_id (const ::Ice::Current &current) 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 &current) 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 &current) const override
 Determines whether this object supports an interface with the given Slice type ID. More...
 
virtual ::std::shared_ptr< TopicPrxretrieve (::std::string name, const ::Ice::Current &current) const =0
 Retrieve a topic by name. More...
 
virtual TopicDict retrieveAll (const ::Ice::Current &current) const =0
 Retrieve all topics managed by this topic manager. 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 &current) 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 &current) const
 Returns the Slice type IDs of the interfaces supported by this object. More...
 
virtual bool ice_isA (std::string s, const Current &current) const
 Tests whether this object supports a specific Slice interface. More...
 
virtual void ice_ping (const Current &current) 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...
 

Detailed Description

A topic manager manages topics, and subscribers to topics.

See also
Topic

Member Typedef Documentation

◆ ProxyType

Member Function Documentation

◆ create()

virtual ::std::shared_ptr<TopicPrx> IceStorm::TopicManager::create ( ::std::string  name,
const ::Ice::Current current 
)
pure virtual

Create a new topic.

The topic name must be unique.

Parameters
nameThe name of the topic.
currentThe Current object for the invocation.
Returns
A proxy to the topic instance.
Exceptions
IceStorm::TopicExistsRaised if a topic with the same name already exists.

◆ getSliceChecksums()

virtual ::Ice::SliceChecksumDict IceStorm::TopicManager::getSliceChecksums ( const ::Ice::Current current) const
pure virtual

Returns the checksums for the IceStorm Slice definitions.

Parameters
currentThe Current object for the invocation.
Returns
A dictionary mapping Slice type ids to their checksums.

◆ ice_id()

virtual ::std::string IceStorm::TopicManager::ice_id ( const ::Ice::Current current) const
override

Obtains a Slice type ID representing the most-derived interface supported by this object.

Parameters
currentThe Current object for the invocation.
Returns
A fully-scoped type ID.

◆ ice_ids()

virtual ::std::vector<::std::string> IceStorm::TopicManager::ice_ids ( const ::Ice::Current current) const
override

Obtains a list of the Slice type IDs representing the interfaces supported by this object.

Parameters
currentThe Current object for the invocation.
Returns
A list of fully-scoped type IDs.

◆ ice_isA()

virtual bool IceStorm::TopicManager::ice_isA ( ::std::string  id,
const ::Ice::Current current 
) const
overridevirtual

Determines whether this object supports an interface with the given Slice type ID.

Parameters
idThe fully-scoped Slice type ID.
currentThe Current object for the invocation.
Returns
True if this object supports the interface, false, otherwise.

◆ ice_staticId()

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

Obtains the Slice type ID corresponding to this class.

Returns
A fully-scoped type ID.

◆ retrieve()

virtual ::std::shared_ptr<TopicPrx> IceStorm::TopicManager::retrieve ( ::std::string  name,
const ::Ice::Current current 
) const
pure virtual

Retrieve a topic by name.

Parameters
nameThe name of the topic.
currentThe Current object for the invocation.
Returns
A proxy to the topic instance.
Exceptions
IceStorm::NoSuchTopicRaised if the topic does not exist.

◆ retrieveAll()

virtual TopicDict IceStorm::TopicManager::retrieveAll ( const ::Ice::Current current) const
pure virtual

Retrieve all topics managed by this topic manager.

Parameters
currentThe Current object for the invocation.
Returns
A dictionary of string, topic proxy pairs.

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