clearpath::horizon::protocol::Client Class Reference

List of all members.

Public Member Functions

def __del__
def __init__
 Create A Horizon Protocol Client.
def __str__
def add_handler
def close
def command
def do_handlers
def emergency_stop
def get_waiting
def is_open
def open
def remove_handler
def request
def send_message
def timestamp

Public Attributes

 acks
 start_time

Private Member Functions

def _receiver

Private Attributes

 _handlers
 _handlers_lock
 Message Handlers.
 _rec_timeout
 _received
 _retries
 _send_timeout
 _transport
 _transport_args
 _transport_func

Detailed Description

Horizon Transport Protocol Controller - Client Device

Definition at line 193 of file protocol.py.


Member Function Documentation

def clearpath::horizon::protocol::Client::__del__ (   self  ) 
Destroy A Horizon Transport

Definition at line 248 of file protocol.py.

def clearpath::horizon::protocol::Client::__init__ (   self,
  transport,
  transport_args,
  retries,
  send_timeout,
  rec_timeout,
  store_timeout 
)

Create A Horizon Protocol Client.

Constructor for the Horizon message Transport protocol client.
Performs the initial creation and initialization of the underlying transport.
Does NOT support version auto-detection.

Refer to the transport's __init__ method for argument specifications.
Override this method for subclass initialization.
Overriding methods should call this method.

Parameters:
retries The number of times to retry sending a message that received a timeout or checksum error
send_timeout The time to wait for an acknowledgment in milliseconds, 0 - wait indefinitely
store_timeout The time to store an un-handled message for the method get_waiting in milliseconds, 0 - store indefinitely
sys_time Use system time (True) instead of time since instantiation (False)?
transport The Transport class to use.
transport_args Dictionary of arguments to pass to the transport's __init__ method. Do NOT include version or store_timeout as these will be populated.

Definition at line 225 of file protocol.py.

def clearpath::horizon::protocol::Client::__str__ (   self  ) 
Return the transport name.

Definition at line 254 of file protocol.py.

def clearpath::horizon::protocol::Client::_receiver (   self,
  name,
  payload,
  timestamp 
) [private]

Definition at line 325 of file protocol.py.

def clearpath::horizon::protocol::Client::add_handler (   self,
  handler,
  backtrack = False,
  request = None 
)
Horizon Protocol Add Data Message Handler

Definition at line 373 of file protocol.py.

def clearpath::horizon::protocol::Client::close (   self  ) 

Definition at line 269 of file protocol.py.

def clearpath::horizon::protocol::Client::command (   self,
  name,
  args 
)

Definition at line 284 of file protocol.py.

def clearpath::horizon::protocol::Client::do_handlers (   self,
  message 
)

Definition at line 408 of file protocol.py.

def clearpath::horizon::protocol::Client::emergency_stop (   self  ) 

Definition at line 279 of file protocol.py.

def clearpath::horizon::protocol::Client::get_waiting (   self,
  request = None 
)

Definition at line 420 of file protocol.py.

def clearpath::horizon::protocol::Client::is_open (   self  ) 

Definition at line 432 of file protocol.py.

def clearpath::horizon::protocol::Client::open (   self  ) 

Definition at line 259 of file protocol.py.

def clearpath::horizon::protocol::Client::remove_handler (   self,
  handler,
  request = None 
)
Horizon Protocol Remove Data Message Handler

Definition at line 391 of file protocol.py.

def clearpath::horizon::protocol::Client::request (   self,
  name,
  args 
)

Definition at line 289 of file protocol.py.

def clearpath::horizon::protocol::Client::send_message (   self,
  message 
)
Horizon Protocol Send Message

Definition at line 330 of file protocol.py.

def clearpath::horizon::protocol::Client::timestamp (   self  ) 

Definition at line 275 of file protocol.py.


Member Data Documentation

Definition at line 230 of file protocol.py.

Message Handlers.

Definition at line 229 of file protocol.py.

Definition at line 238 of file protocol.py.

Definition at line 291 of file protocol.py.

Definition at line 236 of file protocol.py.

Definition at line 237 of file protocol.py.

Definition at line 233 of file protocol.py.

Definition at line 235 of file protocol.py.

Definition at line 234 of file protocol.py.

Definition at line 240 of file protocol.py.

Definition at line 232 of file protocol.py.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Properties


clearpath_base
Author(s): Mike Purvis
autogenerated on Fri Jan 11 10:11:36 2013