Added comments about RAETChannel use cases

This commit is contained in:
Samuel M Smith 2014-09-23 11:51:58 -06:00
parent 35db9c581d
commit fd68f9f41b

View File

@ -58,11 +58,23 @@ class RAETChannel(Channel):
Build the communication framework to communicate over the local process
uxd socket and send messages forwarded to the master. then wait for the
relative return message.
Two use cases:
mininion to master communication, normal use case
Minion is communicating via yard through minion Road to master
The destination route needs the estate name of the associated master
master call via runner, special use case
In the special case the master call external process is communicating
via a yard with the master manor yard
The destination route estate is None to indicate local estate
The difference between the two is how the destination route
is assigned.
'''
def __init__(self, opts, **kwargs):
self.opts = opts
self.ttype = 'raet'
self.dst = ('master', None, 'remote_cmd')
self.dst = ('master', None, 'remote_cmd') # minion to master comms
#self.dst = (None, None, 'remote_cmd')
self.stack = None