IceStorm.TopicManagerPrx

class IceStorm.TopicManagerPrx

Bases: ObjectPrx

Represents an object that manages topics.

Notes

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

create(name: str, context: dict[str, str] | None = None) → TopicPrx | None

Creates a new topic.

Parameters:

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

  • context (dict[str, str]) – The request context for the invocation.

Returns:

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

Return type:

TopicPrx | None

Raises:

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

createAsync(name: str, context: dict[str, str] | None = None) → Awaitable[TopicPrx | None]

Creates a new topic.

Parameters:

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

  • context (dict[str, str]) – The request context for the invocation.

Returns:

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

Return type:

Awaitable[TopicPrx | None]

retrieve(name: str, context: dict[str, str] | None = None) → TopicPrx | None

Retrieves a topic by name.

Parameters:

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

  • context (dict[str, str]) – The request context for the invocation.

Returns:

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

Return type:

TopicPrx | None

Raises:

NoSuchTopic – Thrown when there is no topic named name.

retrieveAsync(name: str, context: dict[str, str] | None = None) → Awaitable[TopicPrx | None]

Retrieves a topic by name.

Parameters:

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

  • context (dict[str, str]) – The request context for the invocation.

Returns:

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

Return type:

Awaitable[TopicPrx | None]

createOrRetrieve(name: str, context: dict[str, str] | None = None) → 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.

  • context (dict[str, str]) – The request context for the invocation.

Returns:

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

Return type:

TopicPrx | None

createOrRetrieveAsync(name: str, context: dict[str, str] | None = 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.

  • context (dict[str, str]) – The request context for the invocation.

Returns:

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

Return type:

Awaitable[TopicPrx | None]

retrieveAll(context: dict[str, str] | None = None) → dict[str, TopicPrx | None]

Retrieves all topics managed by this topic manager.

Parameters:

context (dict[str, str]) – The request context for the invocation.

Returns:

A dictionary of string, topic proxy pairs.

Return type:

dict[str, TopicPrx | None]

retrieveAllAsync(context: dict[str, str] | None = None) → Awaitable[dict[str, TopicPrx | None]]

Retrieves all topics managed by this topic manager.

Parameters:

context (dict[str, str]) – The request context for the invocation.

Returns:

A dictionary of string, topic proxy pairs.

Return type:

Awaitable[dict[str, TopicPrx | None]]

static checkedCast(proxy: ObjectPrx | None, facet: str | None = None, context: dict[str, str] | None = None) → TopicManagerPrx | None

Creates a new proxy from an existing proxy after confirming the target object’s type via a remote invocation.

Parameters:

  • proxy (ObjectPrx | None) – The source proxy.

  • facet (str | None, optional) – A facet name.

  • context (dict[str, str] | None, optional) – The request context.

Returns:

A new proxy with the requested facet, or None if the source proxy is None or if the target object/facet does not support the requested type.

Return type:

ObjectPrx | None

static checkedCastAsync(proxy: ObjectPrx | None, facet: str | None = None, context: dict[str, str] | None = None) → Awaitable[TopicManagerPrx | None]

Creates a new proxy from an existing proxy after confirming the target object’s type via a remote invocation.

Parameters:

  • proxy (ObjectPrx | None) – The source proxy.

  • facet (str | None, optional) – A facet name.

  • context (dict[str, str] | None, optional) – The request context.

Returns:

An Awaitable that completes when the invocation completes. It holds a new proxy with the requested facet, or None if the source proxy is None or if the target object/facet does not support the requested type.

Return type:

Awaitable[ObjectPrx | None]

static uncheckedCast(proxy: ObjectPrx, facet: str | None = None) → TopicManagerPrx
static uncheckedCast(proxy: None, facet: str | None = None) → None

Creates a new proxy from an existing proxy.

Parameters:

  • proxy (ObjectPrx | None) – The source proxy.

  • facet (str | None, optional) – A facet name.

Returns:

A new proxy with the requested facet, or None if the source proxy is None.

Return type:

ObjectPrx | None

static ice_staticId() → str

Returns the Slice type ID associated with this type.

Returns:

The Slice type ID.

Return type:

str