Public Member Functions | Public Attributes
rosbridge_library.internal.publishers.MultiPublisher Class Reference

List of all members.

Public Member Functions

def __init__
def has_clients
def publish
def register_client
def unregister
def unregister_client
def verify_type

Public Attributes

 clients
 latched_client_id
 listener
 msg_class
 publisher
 topic

Detailed Description

Keeps track of the clients that are using a particular publisher.

Provides an API to publish messages and register clients that are using
this publisher 

Definition at line 120 of file publishers.py.


Constructor & Destructor Documentation

def rosbridge_library.internal.publishers.MultiPublisher.__init__ (   self,
  topic,
  msg_type = None,
  latched_client_id = None,
  queue_size = 100 
)
Register a publisher on the specified topic.

Keyword arguments:
topic    -- the name of the topic to register the publisher to
msg_type -- (optional) the type to register the publisher as.  If not
provided, an attempt will be made to infer the topic type
latch    -- (optional) if a client requested this publisher to be latched,
    provide the client_id of that client here

Throws:
TopicNotEstablishedException -- if no msg_type was specified by the
caller and the topic is not yet established, so a topic type cannot
be inferred
TypeConflictException        -- if the msg_type was specified by the
caller and the topic is established, and the established type is
different to the user-specified msg_type

Definition at line 126 of file publishers.py.


Member Function Documentation

Return true if there are clients to this publisher. 

Definition at line 241 of file publishers.py.

Publish a message using this publisher.

Keyword arguments:
msg -- the dict (json) message to publish

Throws:
Exception -- propagates exceptions from message conversion if the
provided msg does not properly conform to the message type of this
publisher

Definition at line 194 of file publishers.py.

Register the specified client as a client of this publisher.

Keyword arguments:
client_id -- the ID of the client using the publisher

Definition at line 219 of file publishers.py.

Unregisters the publisher and clears the clients 

Definition at line 172 of file publishers.py.

Unregister the specified client from this publisher.

If the specified client_id is not a client of this publisher, nothing
happens.

Keyword arguments:
client_id -- the ID of the client to remove

Definition at line 228 of file publishers.py.

Verify that the publisher publishes messages of the specified type.

Keyword arguments:
msg_type -- the type to check this publisher against

Throws:
Exception -- if ros_loader cannot load the specified msg type
TypeConflictException -- if the msg_type is different than the type of
this publisher

Definition at line 177 of file publishers.py.


Member Data Documentation

Definition at line 143 of file publishers.py.

Definition at line 143 of file publishers.py.

Definition at line 143 of file publishers.py.

Definition at line 143 of file publishers.py.

Definition at line 143 of file publishers.py.

Definition at line 143 of file publishers.py.


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


rosbridge_library
Author(s): Jonathan Mace
autogenerated on Wed Sep 13 2017 03:18:07