twisted.internet.process.ProcessReader

class documentation

class ProcessReader(abstract.FileDescriptor): (source)

Constructor: ProcessReader(reactor, proc, name, fileno)

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 connectionLost Close my end of the pipe, signal the Process (which signals the ProcessProtocol).
Method dataReceived Undocumented
Method doRead This is called when the pipe becomes readable.
Method fileno Return the fileno() of my process's stderr.
Method loseConnection Close the connection at the next available opportunity.
Method writeSomeData Write as much as possible of the given data, immediately.
Instance Variable connected Undocumented
Instance Variable disconnecting Undocumented
Instance Variable fd Undocumented
Instance Variable name Undocumented
Instance Variable proc Undocumented

Inherited from FileDescriptor:

Method doWrite Called when data can be written.
Method getHost Similar to getPeer, but returns an address describing this side of the connection.
Method getPeer Get the remote address of this connection.
Method loseWriteConnection Undocumented
Method pauseProducing Pause producing data.
Method readConnectionLost Indicates read connection was lost.
Method resumeProducing Resume producing data.
Method startReading Start waiting for read availability.
Method startWriting Start waiting for write availability.
Method stopConsuming Stop consuming data.
Method stopProducing Stop producing data.
Method stopReading Stop waiting for read availability.
Method stopWriting Stop waiting for write availability.
Method write Reliably write some data.
Method writeConnectionLost Indicates write connection was lost.
Method writeSequence Reliably write a sequence of data.
Constant SEND_LIMIT Undocumented
Class Variable bufferSize Undocumented
Instance Variable dataBuffer Undocumented
Instance Variable disconnected Undocumented
Instance Variable offset Undocumented
Instance Variable producer Undocumented
Instance Variable producerPaused Undocumented
Instance Variable reactor Undocumented
Method _closeWriteConnection Undocumented
Method _isSendBufferFull Determine whether the user-space send buffer for this transport is full or not.
Method _maybePauseProducer Possibly pause a producer, if there is one and the send buffer is full.
Method _postLoseConnection Called after a loseConnection(), when all data has been written.
Class Variable _writeDisconnected Undocumented
Instance Variable _tempDataBuffer Undocumented
Instance Variable _tempDataLen Undocumented
Instance Variable _writeDisconnecting Undocumented

Inherited from _ConsumerMixin (via FileDescriptor):

Method registerProducer Register to receive data from a producer.
Method unregisterProducer Stop consuming data from a producer, without disconnecting.
Instance Variable streamingProducer bool or int

Inherited from _LogOwner (via FileDescriptor, _ConsumerMixin):

Method logPrefix 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 _getLogPrefix 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