Public Member Functions | Static Public Attributes | Private Attributes
rosbridge_library.capabilities.subscribe.Subscribe Class Reference
Inheritance diagram for rosbridge_library.capabilities.subscribe.Subscribe:
Inheritance graph
[legend]

List of all members.

Public Member Functions

def __init__
def finish
def publish
def subscribe
def unsubscribe

Static Public Attributes

list subscribe_msg_fields
list unsubscribe_msg_fields = [(True, "topic", (str, unicode))]

Private Attributes

 _subscriptions

Detailed Description

Definition at line 178 of file subscribe.py.


Constructor & Destructor Documentation

Abstract class constructor.  All capabilities require a handle to
the containing protocol.

Keyword arguments:
protocol -- the protocol instance for this capability instance

Reimplemented from rosbridge_library.capability.Capability.

Definition at line 185 of file subscribe.py.


Member Function Documentation

Notify this capability that the client is finished and that it's
time to free up resources. 

Reimplemented from rosbridge_library.capability.Capability.

Definition at line 259 of file subscribe.py.

def rosbridge_library.capabilities.subscribe.Subscribe.publish (   self,
  topic,
  message,
  fragment_size = None,
  compression = "none" 
)
Publish a message to the client

Keyword arguments:
topic   -- the topic to publish the message on
message -- a dict of key-value pairs. Will be wrapped in a message with
opcode publish
fragment_size -- (optional) fragment the serialized message into msgs
with payloads not greater than this value
compression   -- (optional) compress the message. valid values are
'png' and 'none'

Definition at line 239 of file subscribe.py.

Definition at line 195 of file subscribe.py.

Definition at line 222 of file subscribe.py.


Member Data Documentation

Definition at line 185 of file subscribe.py.

Initial value:
[(True, "topic", (str, unicode)), (False, "type", (str, unicode)),
        (False, "throttle_rate", int), (False, "fragment_size", int),
        (False, "queue_length", int), (False, "compression", (str, unicode))]

Definition at line 180 of file subscribe.py.

list rosbridge_library::capabilities::subscribe.Subscribe::unsubscribe_msg_fields = [(True, "topic", (str, unicode))] [static]

Definition at line 183 of file subscribe.py.


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


rosbridge_library
Author(s): Jonathan Mace
autogenerated on Mon Oct 6 2014 06:58:09