Public Member Functions | Public Attributes | List of all members
rosbridge_library.capabilities.advertise.Registration Class Reference

Public Member Functions

def __init__ (self, client_id, topic)
 
def is_empty (self)
 
def register_advertisement (self, msg_type, adv_id=None, latch=False, queue_size=100)
 
def unregister (self)
 
def unregister_advertisement (self, adv_id=None)
 

Public Attributes

 client_id
 
 clients
 
 topic
 

Detailed Description

Keeps track of how many times a client has requested to advertise
a publisher.

A client could advertise and unadvertise a topic multiple times, and we
must make sure that the underlying publisher is only created and destroyed
at the appropriate moments

Definition at line 40 of file advertise.py.

Constructor & Destructor Documentation

◆ __init__()

def rosbridge_library.capabilities.advertise.Registration.__init__ (   self,
  client_id,
  topic 
)

Definition at line 50 of file advertise.py.

Member Function Documentation

◆ is_empty()

def rosbridge_library.capabilities.advertise.Registration.is_empty (   self)

Definition at line 71 of file advertise.py.

◆ register_advertisement()

def rosbridge_library.capabilities.advertise.Registration.register_advertisement (   self,
  msg_type,
  adv_id = None,
  latch = False,
  queue_size = 100 
)

Definition at line 59 of file advertise.py.

◆ unregister()

def rosbridge_library.capabilities.advertise.Registration.unregister (   self)

Definition at line 56 of file advertise.py.

◆ unregister_advertisement()

def rosbridge_library.capabilities.advertise.Registration.unregister_advertisement (   self,
  adv_id = None 
)

Definition at line 65 of file advertise.py.

Member Data Documentation

◆ client_id

rosbridge_library.capabilities.advertise.Registration.client_id

Definition at line 52 of file advertise.py.

◆ clients

rosbridge_library.capabilities.advertise.Registration.clients

Definition at line 54 of file advertise.py.

◆ topic

rosbridge_library.capabilities.advertise.Registration.topic

Definition at line 53 of file advertise.py.


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


rosbridge_library
Author(s): Jonathan Mace
autogenerated on Tue Oct 3 2023 02:12:45