Public Member Functions
def	__init__ (self)

def	publish (self, Type[RideMessage] topic, message)
	All subscribed listeners' param signatures have been guaranteed. More...

def	subscribe (self, Callable listener, Type[RideMessage] topic)
	The listener's param signature must be (message) More...

def	unsubscribe (self, Callable listener, Type[RideMessage] topic)

def	unsubscribe_all (self, obj=None)
	If the given object's: More...

Static Private Member Functions
str	_get_topic (Type[RideMessage] topic_cls)

def	_validate_listener (Callable listener)

Private Attributes
	_publisher

Detailed Description

Definition at line 24 of file publisher.py.

Constructor & Destructor Documentation

◆ init()

def robotide.publish.publisher._Publisher.__init__ ( self )

Definition at line 26 of file publisher.py.

Member Function Documentation

◆ _get_topic()

str robotide.publish.publisher._Publisher._get_topic ( Type[RideMessage] topic_cls )

staticprivate

Definition at line 31 of file publisher.py.

◆ _validate_listener()

def robotide.publish.publisher._Publisher._validate_listener ( Callable listener )

staticprivate

Definition at line 37 of file publisher.py.

◆ publish()

def robotide.publish.publisher._Publisher.publish	(		self,
		Type[RideMessage]	topic,
			message
	)

All subscribed listeners' param signatures have been guaranteed.

Definition at line 50 of file publisher.py.

◆ subscribe()

def robotide.publish.publisher._Publisher.subscribe	(		self,
		Callable	listener,
		Type[RideMessage]	topic
	)

The listener's param signature must be (message)

Definition at line 45 of file publisher.py.

◆ unsubscribe()

def robotide.publish.publisher._Publisher.unsubscribe	(		self,
		Callable	listener,
		Type[RideMessage]	topic
	)

Definition at line 53 of file publisher.py.

◆ unsubscribe_all()

def robotide.publish.publisher._Publisher.unsubscribe_all	(	self,
		obj = `None`
	)

If the given object's:

       1. object method
       2. class static function
       3. class function

       is subscribed into PUBLISHER, call this method to unsubscribe all its topics.

       Unsubscribe all topics when input is None.

Definition at line 66 of file publisher.py.

Member Data Documentation

◆ _publisher

robotide.publish.publisher._Publisher._publisher

private

Definition at line 27 of file publisher.py.

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

src/robotide/publish/publisher.py

Public Member Functions

Static Private Member Functions

Private Attributes