# ``twisted`.`internet`.`stdio`.`StandardIO``

class documentation

`class StandardIO: (source)`

Implements interfaces: `twisted.internet.interfaces.IConsumer`, `twisted.internet.interfaces.IHalfCloseableDescriptor`, `twisted.internet.interfaces.IProducer`, `twisted.internet.interfaces.ITransport`

View In Hierarchy

Undocumented

Method | `__init__` | Undocumented
Method | `childConnectionLost` | Undocumented
Method | `childDataReceived` | Undocumented
Method | `connectionLost` | Undocumented
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 | `loseConnection` | Close my connection, after writing all pending data.
Method | `loseWriteConnection` | Undocumented
Method | `pauseProducing` | Undocumented
Method | `readConnectionLost` | Indicates read connection was lost.
Method | `registerProducer` | Register to receive data from a producer.
Method | `resumeProducing` | Undocumented
Method | `startReading` | Compatibility only, don't use. Call resumeProducing.
Method | `stopProducing` | Stop producing data.
Method | `stopReading` | Compatibility only, don't use. Call pauseProducing.
Method | `unregisterProducer` | Stop consuming data from a producer, without disconnecting.
Method | `write` | Write some data to the physical connection, in sequence, in a non-blocking fashion.
Method | `writeConnectionLost` | Indicates write connection was lost.
Method | `writeSequence` | Write an iterable of byte strings to the physical connection.
Instance Variable | `disconnected` | Undocumented
Instance Variable | `disconnecting` | Undocumented
Instance Variable | `protocol` | Undocumented
Method | `_readConnectionLost` | Undocumented
Method | `_writeConnectionLost` | Undocumented
Instance Variable | `_reader` | Undocumented
Instance Variable | `_writer` | Undocumented

def __init__(self, proto, stdin=0, stdout=1, reactor=None): (source)

Undocumented

def childConnectionLost(self, fd, reason): (source)

Undocumented

def childDataReceived(self, fd, data): (source)

Undocumented

def connectionLost(self, reason): (source)

Undocumented

def getHost(self): (source)
from `twisted.internet.interfaces.ITransport`
Similar to getPeer, but returns an address describing this side of the connection.

Returns
An `IAddress` provider.

def getPeer(self): (source)
from `twisted.internet.interfaces.ITransport`

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.

Returns
An `IAddress` provider.

def loseConnection(self): (source)
from `twisted.internet.interfaces.ITransport`

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 loseWriteConnection(self): (source)

Undocumented

def pauseProducing(self): (source)

Undocumented

def readConnectionLost(self, reason): (source)
from `twisted.internet.interfaces.IHalfCloseableDescriptor`
Indicates read connection was lost.
def registerProducer(self, producer, streaming): (source)
from `twisted.internet.interfaces.IConsumer`

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. The consumer will only call `resumeProducing` to balance a previous `pauseProducing` call; the producer is assumed to start in an un-paused state.

Parameters
producer | Undocumented
streaming | `True` if `producer` provides `IPushProducer`, `False` if `producer` provides `IPullProducer`.
Raises
`RuntimeError` | If a producer is already registered.

def resumeProducing(self): (source)

Undocumented

def startReading(self): (source)
Compatibility only, don't use. Call resumeProducing.
def stopProducing(self): (source)
from `twisted.internet.interfaces.IProducer`

Stop producing data.

This tells a producer that its consumer has died, so it must stop producing data for good.

def stopReading(self): (source)
Compatibility only, don't use. Call pauseProducing.
def unregisterProducer(self): (source)
from `twisted.internet.interfaces.IConsumer`
Stop consuming data from a producer, without disconnecting.
def write(self, data): (source)
from `twisted.internet.interfaces.ITransport`

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.

Parameters
data | The data to write.

def writeConnectionLost(self, reason): (source)
from `twisted.internet.interfaces.IHalfCloseableDescriptor`
Indicates write connection was lost.
def writeSequence(self, data): (source)
from `twisted.internet.interfaces.ITransport`

Write an iterable of byte 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 byte string.

Parameters
data | The data to write.

disconnected: `bool` = (source)

Undocumented

disconnecting: `bool` = (source)

Undocumented

protocol = (source)

Undocumented

def _readConnectionLost(self, reason): (source)

Undocumented

def _writeConnectionLost(self, reason): (source)

Undocumented

_reader = (source)

Undocumented

_writer = (source)

Undocumented