twisted.internet.process.ProcessReader

class documentation

class ProcessReader(abstract.FileDescriptor): (source)

View In Hierarchy

ProcessReader

I am a selectable representation of a process's output pipe, such as stdout and stderr.

Method __init__ Initialize, specifying a process to connect to.
Method connection​Lost Close my end of the pipe, signal the Process (which signals the ProcessProtocol).
Method data​Received Undocumented
Method do​Read This is called when the pipe becomes readable.
Method fileno Return the fileno() of my process's stderr.
Method lose​Connection Close the connection at the next available opportunity.
Method write​Some​Data Write as much as possible of the given data, immediately.
Class Variable connected Undocumented
Instance Variable disconnecting Undocumented
Instance Variable fd Undocumented
Instance Variable name Undocumented
Instance Variable proc Undocumented

Inherited from FileDescriptor:

Method do​Write Called when data can be written.
Method get​Host Similar to getPeer, but returns an address describing this side of the connection.
Method get​Peer Get the remote address of this connection.
Method lose​Write​Connection Undocumented
Method pause​Producing Pause producing data.
Method read​Connection​Lost Indicates read connection was lost.
Method resume​Producing Resume producing data.
Method start​Reading Start waiting for read availability.
Method start​Writing Start waiting for write availability.
Method stop​Consuming Stop consuming data.
Method stop​Producing Stop producing data.
Method stop​Reading Stop waiting for read availability.
Method stop​Writing Stop waiting for write availability.
Method write Reliably write some data.
Method write​Connection​Lost Indicates write connection was lost.
Method write​Sequence Reliably write a sequence of data.
Constant SEND​_LIMIT Undocumented
Class Variable buffer​Size Undocumented
Instance Variable data​Buffer Undocumented
Instance Variable disconnected Undocumented
Instance Variable offset Undocumented
Instance Variable producer Undocumented
Instance Variable producer​Paused Undocumented
Instance Variable reactor Undocumented
Method _close​Write​Connection Undocumented
Method _is​Send​Buffer​Full Determine whether the user-space send buffer for this transport is full or not.
Method _maybe​Pause​Producer Possibly pause a producer, if there is one and the send buffer is full.
Method _post​Lose​Connection Called after a loseConnection(), when all data has been written.
Class Variable _write​Disconnected Undocumented
Instance Variable _temp​Data​Buffer Undocumented
Instance Variable _temp​Data​Len Undocumented
Instance Variable _write​Disconnecting Undocumented

Inherited from _ConsumerMixin (via FileDescriptor):

Method register​Producer Register to receive data from a producer.
Method unregister​Producer Stop consuming data from a producer, without disconnecting.
Instance Variable streaming​Producer bool or int

Inherited from _LogOwner (via FileDescriptor):

Method log​Prefix Override this method to insert custom logging behavior. Its return value will be inserted in front of every line. It may be called more times than the number of output lines.
Method _get​Log​Prefix Determine the log prefix to use for messages related to applicationObject, which may or may not be an interfaces.ILoggingContext provider.
def __init__(self, reactor, proc, name, fileno): (source)
overrides twisted.internet.abstract.FileDescriptor.__init__
Initialize, specifying a process to connect to.
def connectionLost(self, reason): (source)
from twisted.internet.interfaces.IFileDescriptor
overrides twisted.internet.abstract.FileDescriptor.connectionLost
Close my end of the pipe, signal the Process (which signals the ProcessProtocol).
def dataReceived(self, data): (source)

Undocumented

def doRead(self): (source)
from twisted.internet.interfaces.IReadDescriptor
overrides twisted.internet.abstract.FileDescriptor.doRead
This is called when the pipe becomes readable.
def fileno(self): (source)
from twisted.internet.interfaces.IFileDescriptor
overrides twisted.internet.abstract.FileDescriptor.fileno
Return the fileno() of my process's stderr.
def loseConnection(self): (source)
from twisted.internet.interfaces.ITransport
overrides twisted.internet.abstract.FileDescriptor.loseConnection

Close the connection at the next available opportunity.

Call this to cause this FileDescriptor to lose its connection. It will first write any data that it has buffered.

If there is data buffered yet to be written, this method will cause the transport to lose its connection as soon as it's done flushing its write buffer. If you have a producer registered, the connection won't be closed until the producer is finished. Therefore, make sure you unregister your producer when it's finished, or the connection will never close.

def writeSomeData(self, data): (source)
overrides twisted.internet.abstract.FileDescriptor.writeSomeData

Write as much as possible of the given data, immediately.

This is called to invoke the lower-level writing functionality, such as a socket's send() method, or a file's write(); this method returns an integer or an exception. If an integer, it is the number of bytes written (possibly zero); if an exception, it indicates the connection was lost.

connected: bool = (source)
overrides twisted.internet.abstract.FileDescriptor.connected

Undocumented

disconnecting: int = (source)
overrides twisted.internet.abstract.FileDescriptor.disconnecting

Undocumented

fd = (source)

Undocumented

name = (source)

Undocumented

proc = (source)

Undocumented