t.f.s.Callback(Stage) : class documentation

Part of twisted.flow.stage View Source View In Hierarchy

Converts a single-thread push interface into a pull interface.

Once this stage is constructed, its result, errback, and finish member variables may be called by a producer. The results of which can be obtained by yielding the Callback and then calling next().

For example:

   source = flow.Callback()
   reactor.callLater(0, lambda: source.result("one"))
   reactor.callLater(.5, lambda: source.result("two"))
   reactor.callLater(1, lambda: source.finish())
   printFlow(source)

Class	Instruction	Undocumented
Method	__init__	Undocumented
Method	result	called by the producer to indicate a successful result
Method	finish	called by producer to indicate successful stream completion
Method	errback	called by the producer in case of Failure
Method	_yield	executed during a yield statement by previous stage

Inherited from Stage:

Method	__iter__	Undocumented
Method	next	return current result

def __init__(self, *trap): (source)

overrides twisted.flow.base.Stage.__init__

Undocumented

def result(self, result): (source)

called by the producer to indicate a successful result

def finish(self): (source)

called by producer to indicate successful stream completion

def errback(self, fail): (source)

called by the producer in case of Failure

def _yield(self): (source)

overrides twisted.flow.base.Stage._yield

executed during a yield statement by previous stage

This method is private within the scope of the flow module, it is used by one stage in the flow to ask a subsequent stage to produce its value. The result of the yield is then stored in self.result and is an instance of Failure if a problem occurred.

API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:02:37.