Pipeline - Scauting-Burgum/ScautNet-python GitHub Wiki

The Pipeline-class combines multiple filters to create a system that's capable of sending and receiving data.

Methods

__init__

Creates and starts the pipeline.

Arguments

  • Any number of filters.

Pipeline.push

Sends data to the socket.

Arguments

  • data; The data to be sent.

Pipeline.pull

Gets data from the socket.

Arguments

  • timeout; Once this timeout expires, the method raises queue.Empty. (Defaults to 1 second)

Raises

  • queue.Empty; When no data can be pulled before the timeout's elapsed.

Pipeline.kill

Kills the pipeline and it's filters.

Properties

Pipeline.alive

Returns True if the pipeline is running and Pipeline.kill hasn't been called, otherwise returns False.

Pipeline.filters

All filters in the pipeline.

Implementation

See the readme.