6. mp_proxy_auxiliary

6.1. Multiprocessing Proxy Auxiliary

module: mp_proxy_auxiliary
synopsis: concrete implementation of a multiprocessing proxy auxiliary

This auxiliary simply spread all commands and received messages to all connected auxiliaries. This auxiliary is only usable through mp proxy connector.

 ___________   ___________         ___________
|           | |           | ..... |           |
|   Aux 1   | |   Aux 1   |       |   Aux n   |
|___________| |___________|       |___________|
      |             |                   |
      |             |                   |
 ___________   ___________         ___________
|           | |           | ..... |           |
|Proxy_con 1| |Proxy_con 2|       |Proxy_con n|
|___________| |___________|       |___________|
      |             |                   |
      |             |                   |
      |             |                   |
 _____________________________________________
|                                             |
|               Proxy Auxiliary               |
|_____________________________________________|
                    |
                    |
 _____________________________________________
|                                             |
|               Connector Channel             |
|_____________________________________________|

class pykiso.lib.auxiliaries.mp_proxy_auxiliary.MpProxyAuxiliary(com, aux_list, activate_trace=False, trace_dir=None, trace_name=None, **kwargs)[source]

Proxy auxiliary for multi auxiliaries communication handling.

..note :: this auxiliary version is using the multiprocessing: auxiliary interface.

Initialize attributes.

Parameters

com (CChannel) – Communication connector
aux_list (List[str]) – list of auxiliary’s alias
activate_trace (bool) – True if the trace is activate otherwise False
trace_dir (Optional[str]) – trace directory path (absolute or relative)
trace_name (Optional[str]) – trace full name (without file extension)

get_proxy_con(aux_list)[source]

Retrieve all connector associated to all given existing Auxiliaries.

If auxiliary alias exists but auxiliary instance was not created yet, create it immediately using ConfigRegistry _aux_cache.

Parameters: aux_list (List[str]) – list of auxiliary’s alias
Return type: Tuple[AuxiliaryInterface]
Returns: tuple containing all connectors associated to all given auxiliaries

run()[source]

Run function of the auxiliary process.

Return type: None

class pykiso.lib.auxiliaries.mp_proxy_auxiliary.TraceOptions(activate, dir, name)

Create new instance of TraceOptions(activate, dir, name)

property activate: Alias for field number 0

property dir: Alias for field number 1

property name: Alias for field number 2