tubes._siphon : API documentation

Function	suspended	A token value meaning that `SiphonPendingValues` was suspended.
Function	finished	A token value meaning that `SiphonPendingValues` has no more values in its queue.
Class	SiphonPendingValues	A queue of pending values which can be suspended and resumed, for representing values pending delivery for a `_Siphon`.
Class	_SiphonPiece	Shared functionality between `_SiphonFount` and `_SiphonDrain`
Class	_SiphonFount	Implementation of `IFount` for `_Siphon`.
Class	_SiphonDrain	Implementation of `IDrain` for `_Siphon`.
Class	_Siphon	A `_Siphon` is an `IDrain` and possibly also an `IFount`, and provides lots of conveniences to make it easy to implement something that does fancy flow control with just a few methods.
Function	_tube2drain	An adapter that can convert an `ITube` to an `IDrain` by wrapping it in a `_Siphon`.

def suspended():

A token value meaning that SiphonPendingValues was suspended.

def finished():

A token value meaning that SiphonPendingValues has no more values in its queue.

def _tube2drain(tube):

An adapter that can convert an ITube to an IDrain by wrapping it in a _Siphon.

Parameters	tube	`ITube`
Returns	`IDrain`

tubes._siphon module documentation