6. proxy_auxiliary

6.1. Proxy Auxiliary

module:

proxy_auxiliary

synopsis:

auxiliary use to connect multiple auxiliaries on a unique connector.

This auxiliary simply spread all commands and received messages to all connected auxiliaries. This auxiliary is only usable through 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.proxy_auxiliary.ProxyAuxiliary(com, aux_list, activate_trace=False, trace_dir=None, trace_name=None, **kwargs)

Proxy auxiliary for multi auxiliaries communication handling.

Initialize attributes.

Parameters:

• com (CChannel) – Communication connector

• aux_list (List[str]) – list of auxiliary’s alias

• activate_trace (bool) – log all received messages in a dedicated trace file or not

• trace_dir (Optional[str]) – where to place the trace

• trace_name (Optional[str]) – trace’s file name

get_proxy_con(aux_list)

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 aliases or instances.

Return type:

Tuple[CCProxy, ...]

Returns:

tuple containing all connectors associated to all given auxiliaries.

run_command(conn, *args, **kwargs)

Transmit an incoming request from a linked proxy channel to the proxy auxiliary’s channel.

Parameters:

• conn (CChannel) – current proxy channel instance which the command comes from

• args (tuple) – postional arguments

• args – named arguments

Return type:

None