t.i.p.PosixReactorBase(_SignalReactorMixin, ReactorBase) : class documentation

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

Known subclasses: twisted.internet._threadedselect.ThreadedSelectReactor, twisted.internet.cfreactor.CFReactor, twisted.internet.default.SelectReactor, twisted.internet.epollreactor.EPollReactor, twisted.internet.gtk2reactor.Gtk2Reactor, twisted.internet.gtkreactor.GtkReactor, twisted.internet.kqreactor.KQueueReactor, twisted.internet.pollreactor.PollReactor, twisted.internet.win32eventreactor.Win32Reactor

Implements interfaces: twisted.internet.interfaces.IReactorArbitrary, twisted.internet.interfaces.IReactorMulticast, twisted.internet.interfaces.IReactorProcess, twisted.internet.interfaces.IReactorSSL, twisted.internet.interfaces.IReactorTCP, twisted.internet.interfaces.IReactorUDP, twisted.internet.interfaces.IReactorUNIX, twisted.internet.interfaces.IReactorUNIXDatagram

A basis for reactors that use file descriptors.
Method __init__ Undocumented
Method installWaker Install a `waker' to allow threads and signals to wake up the IO thread.
Method spawnProcess Spawn a process, with a process protocol.
Method listenUDP Connects a given DatagramProtocol to the given numeric UDP port.
Method connectUDP DEPRECATED.
Method listenMulticast Connects a given DatagramProtocol to the given numeric UDP port.
Method connectUNIX
Method listenUNIX
Method listenUNIXDatagram Connects a given DatagramProtocol to the given path.
Method connectUNIXDatagram Connects a ConnectedDatagramProtocol instance to a path.
Method listenTCP
Method connectTCP
Method connectSSL
Method listenSSL
Method listenWith Start an instance of the given portType listening.
Method connectWith Start an instance of the given connectorType connecting.
Method _disconnectSelectable Utility function for disconnecting a selectable.
Method _removeAll Remove all readers and writers, and return list of Selectables.

Inherited from _SignalReactorMixin:

Method startRunning Forward call to ReactorBase, arrange for signal handlers to be installed if asked.
Method run Undocumented
Method mainLoop Undocumented
Method _handleSignals Install the signal handlers for the Twisted event loop.
Method _handleSigchld Reap all processes on SIGCHLD.

Inherited from ReactorBase:

Method installResolver Set the internal resolver to use to for name lookups.
Method wakeUp Wake up the event loop.
Method doIteration Do one iteration over the readers and writers we know about.
Method addReader Undocumented
Method addWriter Undocumented
Method removeReader Undocumented
Method removeWriter Undocumented
Method removeAll Undocumented
Method getReaders Undocumented
Method getWriters Undocumented
Method resolve Return a Deferred that will resolve a hostname.
Method stop See twisted.internet.interfaces.IReactorCore.stop.
Method crash See twisted.internet.interfaces.IReactorCore.crash.
Method sigInt Handle a SIGINT interrupt.
Method sigBreak Handle a SIGBREAK interrupt.
Method sigTerm Handle a SIGTERM interrupt.
Method disconnectAll Disconnect every reader, and writer in the system.
Method iterate See twisted.internet.interfaces.IReactorCore.iterate.
Method fireSystemEvent See twisted.internet.interfaces.IReactorCore.fireSystemEvent.
Method addSystemEventTrigger See twisted.internet.interfaces.IReactorCore.addSystemEventTrigger.
Method removeSystemEventTrigger See twisted.internet.interfaces.IReactorCore.removeSystemEventTrigger.
Method callWhenRunning See twisted.internet.interfaces.IReactorCore.callWhenRunning.
Method startRunning Method called when reactor starts: do some initialization and fire startup events.
Method callLater See twisted.internet.interfaces.IReactorTime.callLater.
Method cancelCallLater See twisted.internet.interfaces.IReactorTime.cancelCallLater.
Method getDelayedCalls No summary
Method timeout Undocumented
Method runUntilCurrent Run all pending timed calls.
Method callFromThread 0 See twisted.internet.interfaces.IReactorThreads.callFromThread.
Method callInThread See twisted.internet.interfaces.IReactorThreads.callInThread.
Method suggestThreadPoolSize See twisted.internet.interfaces.IReactorThreads.suggestThreadPoolSize.
Method callFromThread Cause a function to be executed by the reactor thread.
Method _moveCallLaterSooner Undocumented
Method _cancelCallLater Undocumented
Method _insertNewDelayedCalls Undocumented
Method _checkProcessArgs Check for valid arguments and environment to spawnProcess.
Method _initThreads Undocumented
Method _initThreadPool Create the threadpool accessible with callFromThread.
Method _stopThreadPool Stop the reactor threadpool.
def __init__(self): (source)
overrides twisted.internet.base.ReactorBase.__init__
overridden in twisted.internet._threadedselect.ThreadedSelectReactor, twisted.internet.cfreactor.CFReactor, twisted.internet.default.SelectReactor, twisted.internet.epollreactor.EPollReactor, twisted.internet.gtk2reactor.Gtk2Reactor, twisted.internet.gtkreactor.GtkReactor, twisted.internet.kqreactor.KQueueReactor, twisted.internet.pollreactor.PollReactor, twisted.internet.win32eventreactor.Win32Reactor
Undocumented
def _disconnectSelectable(self, selectable, why, isRead, faildict={error.ConnectionDone:failure.Failure(error.ConnectionDone()),error.ConnectionLost:failure.Failure(error.ConnectionLost()),}): (source)

Utility function for disconnecting a selectable.

Supports half-close notification, isRead should be boolean indicating whether error resulted from doRead().
def installWaker(self): (source)
overrides twisted.internet.base.ReactorBase.installWaker

Install a `waker' to allow threads and signals to wake up the IO thread.

We use the self-pipe trick (http://cr.yp.to/docs/selfpipe.html) to wake the reactor. On Windows we use a pair of sockets.
def spawnProcess(self, processProtocol, executable, args=(), env={}, path=None, uid=None, gid=None, usePTY=0, childFDs=None): (source)
from twisted.internet.interfaces.IReactorProcess
overridden in twisted.internet.win32eventreactor.Win32Reactor
Spawn a process, with a process protocol.
ParametersprocessProtocolAn object which will be notified of all events related to the created process. (type: IProcessProtocol provider )
executablethe file name to spawn - the full path should be used.
argsthe command line arguments to pass to the process; a sequence of strings. The first string should be the executable's name.
envthe environment variables to pass to the processs; a dictionary of strings. If 'None', use os.environ.
paththe path to run the subprocess in - defaults to the current directory.
uiduser ID to run the subprocess as. (Only available on POSIX systems.)
gidgroup ID to run the subprocess as. (Only available on POSIX systems.)
usePTYif true, run this process in a pseudo-terminal. optionally a tuple of (masterfd, slavefd, ttyname), in which case use those file descriptors. (Not available on all systems.)
childFDs

A dictionary mapping file descriptors in the new child process to an integer or to the string 'r' or 'w'.

If the value is an integer, it specifies a file descriptor in the parent process which will be mapped to a file descriptor (specified by the key) in the child process. This is useful for things like inetd and shell-like file redirection.

If it is the string 'r', a pipe will be created and attached to the child at that file descriptor: the child will be able to write to that file descriptor and the parent will receive read notification via the IProcessProtocol.childDataReceived callback. This is useful for the child's stdout and stderr.

If it is the string 'w', similar setup to the previous case will occur, with the pipe being readable by the child instead of writeable. The parent process can write to that file descriptor using IProcessTransport.writeToChild. This is useful for the child's stdin.

If childFDs is not passed, the default behaviour is to use a mapping that opens the usual stdin/stdout/stderr pipes.
ReturnsAn object which provides IProcessTransport.
RaisesOSErrorRaised with errno EAGAIN or ENOMEM if there are insufficient system resources to create a new process.
See Alsotwisted.internet.protocol.ProcessProtocol
def listenUDP(self, port, protocol, interface='', maxPacketSize=8192): (source)
from twisted.internet.interfaces.IReactorUDP
Connects a given DatagramProtocol to the given numeric UDP port.
Returnsobject conforming to IListeningPort.
def connectUDP(self, remotehost, remoteport, protocol, localport=0, interface='', maxPacketSize=8192): (source)
from twisted.internet.interfaces.IReactorUDP

DEPRECATED.

Connects a ConnectedDatagramProtocol instance to a UDP port.
def listenMulticast(self, port, protocol, interface='', maxPacketSize=8192, listenMultiple=False): (source)
from twisted.internet.interfaces.IReactorMulticast

Connects a given DatagramProtocol to the given numeric UDP port.

EXPERIMENTAL.
Returnsobject conforming to IListeningPort.
def connectUNIX(self, address, factory, timeout=30, checkPID=0): (source)
from twisted.internet.interfaces.IReactorUNIX
overridden in twisted.manhole.gladereactor.GladeReactor
See Alsotwisted.internet.interfaces.IReactorUNIX.connectUNIX
def listenUNIX(self, address, factory, backlog=50, mode=438, wantPID=0): (source)
from twisted.internet.interfaces.IReactorUNIX
overridden in twisted.manhole.gladereactor.GladeReactor
See Alsotwisted.internet.interfaces.IReactorUNIX.listenUNIX
def listenUNIXDatagram(self, address, protocol, maxPacketSize=8192, mode=438): (source)
from twisted.internet.interfaces.IReactorUNIXDatagram

Connects a given DatagramProtocol to the given path.

EXPERIMENTAL.
Returnsobject conforming to IListeningPort.
def connectUNIXDatagram(self, address, protocol, maxPacketSize=8192, mode=438, bindAddress=None): (source)
from twisted.internet.interfaces.IReactorUNIXDatagram

Connects a ConnectedDatagramProtocol instance to a path.

EXPERIMENTAL.
def listenTCP(self, port, factory, backlog=50, interface=''): (source)
from twisted.internet.interfaces.IReactorTCP
overridden in twisted.manhole.gladereactor.GladeReactor
See Alsotwisted.internet.interfaces.IReactorTCP.listenTCP
def connectTCP(self, host, port, factory, timeout=30, bindAddress=None): (source)
from twisted.internet.interfaces.IReactorTCP
overridden in twisted.manhole.gladereactor.GladeReactor
See Alsotwisted.internet.interfaces.IReactorTCP.connectTCP
def connectSSL(self, host, port, factory, contextFactory, timeout=30, bindAddress=None): (source)
from twisted.internet.interfaces.IReactorSSL
overridden in twisted.manhole.gladereactor.GladeReactor
See Alsotwisted.internet.interfaces.IReactorSSL.connectSSL
def listenSSL(self, port, factory, contextFactory, backlog=50, interface=''): (source)
from twisted.internet.interfaces.IReactorSSL
overridden in twisted.manhole.gladereactor.GladeReactor
See Alsotwisted.internet.interfaces.IReactorSSL.listenSSL
def listenWith(self, portType, *args, **kw): (source)
from twisted.internet.interfaces.IReactorArbitrary
Start an instance of the given portType listening.
ParametersportTypeThe object given by portType(*args, **kw) will be started listening. (type: type which implements IListeningPort )
Returnsan object which provides IListeningPort.
def connectWith(self, connectorType, *args, **kw): (source)
from twisted.internet.interfaces.IReactorArbitrary
Start an instance of the given connectorType connecting.
ParametersconnectorTypeThe object given by connectorType(*args, **kw) will be started connecting. (type: type which implements IConnector )
ReturnsAn object which provides IConnector.
def _removeAll(self, readers, writers): (source)

Remove all readers and writers, and return list of Selectables.

Meant for calling from subclasses, to implement removeAll, like: 
 def removeAll(self):
     return self._removeAll(reads, writes)
where reads and writes are iterables.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 15:57:47.