messaging.subscriber_if.SubscriberIf Class Reference

Receive OpenRoadCode messages without exposing transport details. More...

Inheritance diagram for messaging.subscriber_if.SubscriberIf:

Public Member Functions
None	subscribe (self, str topic)
	Subscribe to a topic or transport-specific topic prefix.
tuple[str, Mapping[str, Any]]	receive (self)
	Block until one encoded message is received.
None	close (self)
	Release subscriber resources when the implementation owns any.

Detailed Description

Receive OpenRoadCode messages without exposing transport details.

Member Function Documentation

receive()

tuple[str, Mapping[str, Any]] messaging.subscriber_if.SubscriberIf.receive

(

self

)

Block until one encoded message is received.

Returns

Pair containing the received topic and JSON-compatible payload.

Reimplemented in messaging.zeromq.subscriber.ZeroMqSubscriber.

subscribe()

None messaging.subscriber_if.SubscriberIf.subscribe	(		self,
		str	topic
	)

Subscribe to a topic or transport-specific topic prefix.

Parameters

topic

Public topic name or supported transport-specific prefix.

Reimplemented in messaging.zeromq.subscriber.ZeroMqSubscriber.

---

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

• messaging/subscriber_if.py