tubes._siphon._SiphonFount : API documentation

Implements interfaces: tubes.itube.IFount

Implementation of IFount for _Siphon.

Instance Variable	fount	the implementation of the `IDrain.fount` attribute. The `IFount` which is flowing to this `_Siphon`'s `IDrain` implementation.
Instance Variable	drain	the implementation of the `IFount.drain` attribute. The `IDrain` to which this `_Siphon`'s `IFount` implementation is flowing.
Method	__init__	Undocumented
Method	__repr__	Nice string representation.
Method	outputType	Relay the `outputType` declared by the tube.
Method	flowTo	Flow data from this `_Siphon` to the given drain.
Method	pauseFlow	Pause the flow from the fount, or remember to do that when the fount is attached, if it isn't yet.
Method	stopFlow	Stop the flow from the fount to this `_Siphon`, and stop delivering buffered items.

Inherited from _SiphonPiece:

Method _tube Expose the siphon's _tube directly since many things will want to manipulate it.

fount =

the implementation of the IDrain.fount attribute. The IFount which is flowing to this _Siphon's IDrain implementation.

drain =

the implementation of the IFount.drain attribute. The IDrain to which this _Siphon's IFount implementation is flowing.

def __init__(self, siphon):

Undocumented

def __repr__(self):

Nice string representation.

@property
def outputType(self):

Relay the outputType declared by the tube.

Returns see IFount.outputType

def flowTo(self, drain):

Flow data from this _Siphon to the given drain.

Parameters	drain	see `IFount.flowTo`
Returns	an `IFount` that emits items of the output-type of this siphon's tube.

def pauseFlow(self):

Pause the flow from the fount, or remember to do that when the fount is attached, if it isn't yet.

Returns IPause

def stopFlow(self):

Stop the flow from the fount to this _Siphon, and stop delivering buffered items.

API Documentation for tubes, generated by pydoctor at 2016-01-18 07:46:47.

tubes._siphon._SiphonFount(_SiphonPiece) class documentation