Topic

class swordfish._swordfishcpp.Topic

info: TopicInfo

Information related to the topic.

stat: SubscriptionStat

Statistics related to the topic’s subscription.

unsubscribe(remove_offset=True)

Unsubscribe from the topic.

Parameters:

remove_offset (bool, optional) – Whether to remove the current offset. Defaults to True.

remove_offset()

Remove the stored offset.

Return type:

None

property processed_offset: int

Get the processed data offset.

Returns:

The offset.

Return type:

int

classmethod get_with_detail(table_name, action_name, node_alias='')

Retrieve a topic along with detailed information by specifying the table name, action name, and optional node alias.

Parameters:

• table_name (str) – Name of the table associated with the topic.

• action_name (str) – Action name related to the topic.

• node_alias (str, optional) – Alias of the node. Defaults to “”.

Returns:

Topic related to the table and action.

Return type:

Topic

classmethod get_with_topic(topic)

Retrieve a topic based on the topic string.

Parameters:

topic (str) – Topic string identifier.

Returns:

Topic corresponding to the given topic identifier.

Return type:

Topic