IceStorm.TopicManager

class IceStorm.TopicManager

Bases: Object, ABC

Represents an object that manages topics.

Notes

The Slice compiler generated this skeleton class from Slice interface ::IceStorm::TopicManager.

abstractmethod create(name: str, current: Current) → TopicPrx | None | Awaitable[TopicPrx | None]

Creates a new topic.

Parameters:

  • name (str) – The name of the topic.

  • current (Ice.Current) – The Current object for the dispatch.

Returns:

A proxy to the new topic object. The returned proxy is never null.

Return type:

TopicPrx | None | Awaitable[TopicPrx | None]

Raises:

TopicExists – Thrown when a topic with the same name already exists.

abstractmethod createOrRetrieve(name: str, current: Current) → TopicPrx | None | Awaitable[TopicPrx | None]

Creates a new topic with the given name, or retrieves the existing topic with this name if it already exists.

Parameters:

  • name (str) – The name of the topic.

  • current (Ice.Current) – The Current object for the dispatch.

Returns:

A proxy to the topic object. The returned proxy is never null.

Return type:

TopicPrx | None | Awaitable[TopicPrx | None]

static ice_staticId() → str

Obtain the type ID of the Slice interface.

Returns:

The type ID.

Return type:

str

abstractmethod retrieve(name: str, current: Current) → TopicPrx | None | Awaitable[TopicPrx | None]

Retrieves a topic by name.

Parameters:

  • name (str) – The name of the topic.

  • current (Ice.Current) – The Current object for the dispatch.

Returns:

A proxy to the topic object. The returned proxy is never null.

Return type:

TopicPrx | None | Awaitable[TopicPrx | None]

Raises:

NoSuchTopic – Thrown when there is no topic named name.

abstractmethod retrieveAll(current: Current) → Mapping[str, TopicPrx | None] | Awaitable[Mapping[str, TopicPrx | None]]

Retrieves all topics managed by this topic manager.

Parameters:

current (Ice.Current) – The Current object for the dispatch.

Returns:

A dictionary of string, topic proxy pairs.

Return type:

Mapping[str, TopicPrx | None] | Awaitable[Mapping[str, TopicPrx | None]]