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

Public Member Functions

def __init__ (self, protocol)
 
def finish (self)
 
def publish (self, topic, message, fragment_size=None, compression="none")
 
def subscribe (self, msg)
 
def unsubscribe (self, msg)
 
- Public Member Functions inherited from rosbridge_library.capability.Capability
def __init__ (self, protocol)
 
def basic_type_check (self, msg, types_info)
 
def finish (self)
 
def handle_message (self, message)
 

Static Public Attributes

list subscribe_msg_fields
 
 topics_glob = None
 
list unsubscribe_msg_fields = [(True, "topic", string_types)]
 

Private Attributes

 _subscriptions
 

Additional Inherited Members

- Public Attributes inherited from rosbridge_library.capability.Capability
 protocol
 

Detailed Description

Definition at line 201 of file subscribe.py.

Constructor & Destructor Documentation

def rosbridge_library.capabilities.subscribe.Subscribe.__init__ (   self,
  protocol 
)

Definition at line 210 of file subscribe.py.

Member Function Documentation

def rosbridge_library.capabilities.subscribe.Subscribe.finish (   self)

Definition at line 344 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 ROS message wrapped by OutgoingMessage
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 293 of file subscribe.py.

def rosbridge_library.capabilities.subscribe.Subscribe.subscribe (   self,
  msg 
)

Definition at line 220 of file subscribe.py.

def rosbridge_library.capabilities.subscribe.Subscribe.unsubscribe (   self,
  msg 
)

Definition at line 262 of file subscribe.py.

Member Data Documentation

rosbridge_library.capabilities.subscribe.Subscribe._subscriptions
private

Definition at line 218 of file subscribe.py.

list rosbridge_library.capabilities.subscribe.Subscribe.subscribe_msg_fields
static
Initial value:
1 = [(True, "topic", string_types), (False, "type", string_types),
2  (False, "throttle_rate", int), (False, "fragment_size", int),
3  (False, "queue_length", int), (False, "compression", string_types)]

Definition at line 203 of file subscribe.py.

rosbridge_library.capabilities.subscribe.Subscribe.topics_glob = None
static

Definition at line 208 of file subscribe.py.

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

Definition at line 206 of file subscribe.py.


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


rosbridge_library
Author(s): Jonathan Mace
autogenerated on Wed Jun 3 2020 03:55:14