titanfe.apps.brick_runner.adapter module

The BrickAdapter get’s passed into the brick’s module on execution

class titanfe.apps.brick_runner.adapter.AdapterMeta(brick: titanfe.apps.brick_runner.adapter.MetaData, flow: titanfe.apps.brick_runner.adapter.MetaData)

Bases: object

flow/brick meta data to be made available for access inside a brick

brick: titanfe.apps.brick_runner.adapter.MetaData

flow: titanfe.apps.brick_runner.adapter.MetaData

class titanfe.apps.brick_runner.adapter.BrickAdapter(meta_data: titanfe.apps.brick_runner.adapter.AdapterMeta, result_put_callback, log, default_port)

Bases: object

The BrickAdapter get’s passed into the brick’s module on execution

Parameters

• result_put_callback (Callable) – callback to output a result to the runner

• log (logging.Logger) – the logger instance of the parent runner

Attributes

log: a logging.logger instance to be used from within the brick’s module

if one wants to have something in the general application log.

decrypt_parameter(parameter)

Decrypt a secret parameter using AES GCM

Parameters

parameter (String) – hex encoded encryped parameter

emit_new_packet(value, port=None)

A new packet will be created from the given value and infused into the flow of data.

Note

This will create and output a new packet into the flow. To modify the payload of an already travelling packet, simply return a value from the brick processing method.

Parameters

value (Any) – Any value

class titanfe.apps.brick_runner.adapter.MetaData(uid, name)

Bases: tuple

property name

Alias for field number 1

property uid

Alias for field number 0

class titanfe.apps.brick_runner.adapter.State(flow_id, brick_uid, log)

Bases: object

State allows bricks to persist/get state and the brick runner to reset it during teardown

get()

Getting brick state

reset()

Delete brick state

set(value)

Store brick state :param value: state to be stored :type value: Any