Classes | Variables
clearpath.horizon.transports Namespace Reference

Module. More...

Classes

class  Serial
 Horizon Serial Controller. More...
class  Transport
 Horizon Transport Controller. More...

Variables

string __revision__ = "$Revision: 898 $"
 SVN Code Revision.
string __version__ = "1.0"
 Module Version.
tuple logger = logging.getLogger('clearpath.horizon.transports')
 Message Log.
tuple MessageRecord = collections.namedtuple('MessageRecord', 'message, expiry')

Detailed Description

Module.

Horizon Transports Python Module

Horizon Message Transport Controllers
Supported Horizon version(s): 0.1 - 1.0

Supported Transports:

Author:
Ryan Gariepy
Malcolm Robert
Date:
18/01/10
Todo:

Would be nice to support version translation in IP Servers, however, that would require additional work to detect the version that clients are using which is currently not supported by the current framework.

FIX encryption clearpath.utils
clearpath.horizon.messages
clearpath.horizon.payloads
pySerial [http://pyserial.sourceforge.net/]
-- for Serial

Version:
1.0

USE

The intended purpose of this module is to provide functionality to send and receive Horizon messages over the various transports with minimal knowledge of messages and no knowledge of message payloads. Further, as some transports support a one-to-many connection scheme, this module also provides message routing. Note that as this module implements the transports as defined in the Horizon specification, there is no support for version translation. If version translation is desired, refer to the module clearpath.horizon.forward.

HISTORY

Versions 0.1 - 0.3 {Ryan Gariepy}

Version 0.4 {Malcolm Robert}

Version 0.5

Version 0.6

Version 0.7

Version 0.8

Version 1.0

License


Variable Documentation

string clearpath::horizon::transports.__revision__ = "$Revision: 898 $"

SVN Code Revision.

Definition at line 204 of file transports.py.

Module Version.

Definition at line 201 of file transports.py.

tuple clearpath::horizon::transports.logger = logging.getLogger('clearpath.horizon.transports')

Message Log.

Definition at line 209 of file transports.py.

tuple clearpath::horizon::transports.MessageRecord = collections.namedtuple('MessageRecord', 'message, expiry')

Definition at line 196 of file transports.py.



clearpath_base
Author(s): Mike Purvis
autogenerated on Sun Oct 5 2014 22:52:08