t.i._.StandardIO(_pollingfile._PollingTimer) : class documentation

Part of twisted.internet._win32stdio View Source View In Hierarchy

Implements interfaces: twisted.internet.interfaces.IConsumer, twisted.internet.interfaces.IPushProducer, twisted.internet.interfaces.ITransport

No class docstring
Method __init__ Start talking to standard IO with the given protocol.
Method dataReceived Undocumented
Method readConnectionLost Undocumented
Method writeConnectionLost Undocumented
Method checkConnLost Undocumented
Method write Write some data to the physical connection, in sequence, in a non-blocking fashion.
Method writeSequence Write a list of strings to the physical connection.
Method loseConnection Close my connection, after writing all pending data.
Method getPeer Get the remote address of this connection.
Method getHost Similar to getPeer, but returns an address describing this side of the connection.
Method registerProducer Register to receive data from a producer.
Method unregisterProducer Stop consuming data from a producer, without disconnecting.
Method stopProducing Undocumented
Method pauseProducing Pause producing data.
Method resumeProducing Resume producing data.

Inherited from _PollingTimer:

Method _addPollableResource Undocumented
Method _checkPollingState Undocumented
Method _startPolling Undocumented
Method _stopPolling Undocumented
Method _pause Undocumented
Method _unpause Undocumented
Method _reschedule Undocumented
Method _pollEvent Undocumented
def __init__(self, proto): (source)
Start talking to standard IO with the given protocol.

Also, put it stdin/stdout/stderr into binary mode.

def dataReceived(self, data): (source)
Undocumented
def readConnectionLost(self): (source)
Undocumented
def writeConnectionLost(self): (source)
Undocumented
def checkConnLost(self): (source)
Undocumented
def write(self, data): (source)
Write some data to the physical connection, in sequence, in a non-blocking fashion.

If possible, make sure that it is all written. No data will ever be lost, although (obviously) the connection may be closed before it all gets through.

def writeSequence(self, seq): (source)
Write a list of strings to the physical connection.

If possible, make sure that all of the data is written to the socket at once, without first copying it all into a single string.

def loseConnection(self): (source)
Close my connection, after writing all pending data.

Note that if there is a registered producer on a transport it will not be closed until the producer has been unregistered.

def getPeer(self): (source)
Get the remote address of this connection.

Treat this method with caution. It is the unfortunate result of the CGI and Jabber standards, but should not be considered reliable for the usual host of reasons; port forwarding, proxying, firewalls, IP masquerading, etc.

ReturnsAn IAddress provider.
def getHost(self): (source)
Similar to getPeer, but returns an address describing this side of the connection.
ReturnsAn IAddress provider.
def registerProducer(self, producer, streaming): (source)
Register to receive data from a producer.

This sets self to be a consumer for a producer. When this object runs out of data (as when a send(2) call on a socket succeeds in moving the last data from a userspace buffer into a kernelspace buffer), it will ask the producer to resumeProducing().

For IPullProducer providers, resumeProducing will be called once each time data is required.

For IPushProducer providers, pauseProducing will be called whenever the write buffer fills up and resumeProducing will only be called when it empties.

ParametersstreamingTrue if producer provides IPushProducer, False if producer provides IPullProducer. (type: bool)
ReturnsNone
RaisesRuntimeErrorIf a producer is already registered.
def unregisterProducer(self): (source)
Stop consuming data from a producer, without disconnecting.
def stopProducing(self): (source)
Undocumented
def pauseProducing(self): (source)
Pause producing data.

Tells a producer that it has produced too much data to process for the time being, and to stop until resumeProducing() is called.

def resumeProducing(self): (source)
Resume producing data.

This tells a producer to re-add itself to the main loop and produce more data for its consumer.

API Documentation for Twisted, generated by pydoctor at 2012-09-01 11:44:56.