IceStorm.TopicPrx

class IceStorm.TopicPrx

Bases: ObjectPrx

Represents an IceStorm topic. Publishers publish data to a topic (via the topic’s publisher object), and subscribers subscribe to a topic.

Notes

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

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

Gets the name of this topic.

Parameters:

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

Returns:

The name of the topic.

Return type:

str

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

Gets the name of this topic.

Parameters:

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

Returns:

The name of the topic.

Return type:

Awaitable[str]

getPublisher(context: dict[str, str] | None = None) → ObjectPrx | None

Gets a proxy to a publisher object for this topic. To publish data to a topic, a publisher calls this operation and then creates a proxy with the publisher type from this proxy. If a replicated IceStorm deployment is used, this call may return a replicated proxy.

Parameters:

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

Returns:

A proxy to publish data on this topic. This proxy is never null.

Return type:

ObjectPrx | None

getPublisherAsync(context: dict[str, str] | None = None) → Awaitable[ObjectPrx | None]

Gets a proxy to a publisher object for this topic. To publish data to a topic, a publisher calls this operation and then creates a proxy with the publisher type from this proxy. If a replicated IceStorm deployment is used, this call may return a replicated proxy.

Parameters:

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

Returns:

A proxy to publish data on this topic. This proxy is never null.

Return type:

Awaitable[ObjectPrx | None]

getNonReplicatedPublisher(context: dict[str, str] | None = None) → ObjectPrx | None

Gets a non-replicated proxy to a publisher object for this topic. To publish data to a topic, a publisher calls this operation and then creates a proxy with the publisher type from this proxy.

Parameters:

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

Returns:

A proxy to publish data on this topic. This proxy is never null.

Return type:

ObjectPrx | None

getNonReplicatedPublisherAsync(context: dict[str, str] | None = None) → Awaitable[ObjectPrx | None]

Gets a non-replicated proxy to a publisher object for this topic. To publish data to a topic, a publisher calls this operation and then creates a proxy with the publisher type from this proxy.

Parameters:

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

Returns:

A proxy to publish data on this topic. This proxy is never null.

Return type:

Awaitable[ObjectPrx | None]

subscribeAndGetPublisher(theQoS: Mapping[str, str], subscriber: ObjectPrx | None, context: dict[str, str] | None = None) → ObjectPrx | None

Subscribes to this topic.

Parameters:

  • theQoS (Mapping[str, str]) – The quality of service parameters for this subscription.

  • subscriber (ObjectPrx | None) – The subscriber’s proxy. This proxy cannot be null.

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

Returns:

The per-subscriber publisher proxy. This proxy is never null.

Return type:

ObjectPrx | None

Raises:

  • AlreadySubscribed – Thrown when subscriber is already subscribed.

  • BadQoS – Thrown when theQoS is unavailable or invalid.

subscribeAndGetPublisherAsync(theQoS: Mapping[str, str], subscriber: ObjectPrx | None, context: dict[str, str] | None = None) → Awaitable[ObjectPrx | None]

Subscribes to this topic.

Parameters:

  • theQoS (Mapping[str, str]) – The quality of service parameters for this subscription.

  • subscriber (ObjectPrx | None) – The subscriber’s proxy. This proxy cannot be null.

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

Returns:

The per-subscriber publisher proxy. This proxy is never null.

Return type:

Awaitable[ObjectPrx | None]

unsubscribe(subscriber: ObjectPrx | None, context: dict[str, str] | None = None) → None

Unsubscribes the provided subscriber from this topic.

Parameters:

  • subscriber (ObjectPrx | None) – A proxy to an existing subscriber. This proxy is never null.

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

Return type:

None

unsubscribeAsync(subscriber: ObjectPrx | None, context: dict[str, str] | None = None) → Awaitable[None]

Unsubscribes the provided subscriber from this topic.

Parameters:

  • subscriber (ObjectPrx | None) – A proxy to an existing subscriber. This proxy is never null.

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

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

Creates a link to another topic. All events originating on this topic will also be sent to the other topic.

Parameters:

  • linkTo (TopicPrx | None) – The topic to link to. This proxy cannot be null.

  • cost (int) – The cost of the link.

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

Raises:

LinkExists – Thrown when a link to linkTo already exists.

Return type:

None

linkAsync(linkTo: TopicPrx | None, cost: int, context: dict[str, str] | None = None) → Awaitable[None]

Creates a link to another topic. All events originating on this topic will also be sent to the other topic.

Parameters:

  • linkTo (TopicPrx | None) – The topic to link to. This proxy cannot be null.

  • cost (int) – The cost of the link.

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

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

Destroys a link from this topic to the provided topic.

Parameters:

  • linkTo (TopicPrx | None) – The topic to destroy the link to. This proxy cannot be null.

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

Raises:

NoSuchLink – Thrown when a link to linkTo does not exist.

Return type:

None

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

Destroys a link from this topic to the provided topic.

Parameters:

  • linkTo (TopicPrx | None) – The topic to destroy the link to. This proxy cannot be null.

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

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

getLinkInfoSeq(context: dict[str, str] | None = None) → list[LinkInfo]

Gets information on the current links.

Parameters:

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

Returns:

A sequence of LinkInfo objects.

Return type:

list[LinkInfo]

getLinkInfoSeqAsync(context: dict[str, str] | None = None) → Awaitable[list[LinkInfo]]

Gets information on the current links.

Parameters:

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

Returns:

A sequence of LinkInfo objects.

Return type:

Awaitable[list[LinkInfo]]

getSubscribers(context: dict[str, str] | None = None) → list[Identity]

Gets the list of subscribers for this topic.

Parameters:

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

Returns:

The sequence of Ice identities for the subscriber objects.

Return type:

list[Identity]

getSubscribersAsync(context: dict[str, str] | None = None) → Awaitable[list[Identity]]

Gets the list of subscribers for this topic.

Parameters:

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

Returns:

The sequence of Ice identities for the subscriber objects.

Return type:

Awaitable[list[Identity]]

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

Destroys this topic.

Parameters:

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

Return type:

None

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

Destroys this topic.

Parameters:

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

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

static checkedCast(proxy: ObjectPrx | None, facet: str | None = None, context: dict[str, str] | None = None) → TopicPrx | 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[TopicPrx | 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 uncheckedCast(proxy: ObjectPrx, facet: str | None = None) → TopicPrx
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