class CFReactor(PosixReactorBase): (source)
Implements interfaces: twisted.internet.interfaces.IReactorFDSet
The CoreFoundation reactor.
You probably want to use this via the install
API.
Method | __init__ |
Undocumented |
Method | add |
Implement IReactorFDSet.addReader . |
Method | add |
Implement IReactorFDSet.addWriter . |
Method | call |
Implement IReactorTime.callLater . |
Method | crash |
Implement IReactorCore.crash |
Method | get |
Implement IReactorFDSet.getReaders . |
Method | get |
Implement IReactorFDSet.getWriters . |
Method | install |
Override installWaker in order to use _WakerPlus ; otherwise this should be exactly the same as the parent implementation. |
Method | iterate |
Emulate the behavior of iterate() for things that want to call it, by letting the loop run for a little while and then scheduling a timed call to exit it. |
Method | main |
Run the runner (CFRunLoopRun or something that calls it), which runs the run loop until crash() is called. |
Method | remove |
Implement IReactorFDSet.removeAll . |
Method | remove |
Implement IReactorFDSet.removeReader . |
Method | remove |
Implement IReactorFDSet.removeWriter . |
Method | stop |
Implement IReactorCore.stop . |
Instance Variable | waker |
Undocumented |
Method | _flag2idx |
Convert a kCFSocket... constant to an index into the read/write state list (_READ or _WRITE) (the 4th element of the value of self._fdmap). |
Method | _move |
Override PosixReactorBase 's implementation of IDelayedCall.reset so that it will immediately reschedule. Normally _moveCallLaterSooner depends on the fact that runUntilCurrent is always run before the mainloop goes back to sleep, so this forces it to immediately recompute how long the loop needs to stay asleep. |
Method | _schedule |
Schedule a call to self.runUntilCurrent. This will cancel the currently scheduled call if it is already scheduled. |
Method | _socket |
The socket callback issued by CFRunLoop. This will issue doRead or doWrite calls to the IReadDescriptor and IWriteDescriptor registered with the file descriptor that we are being notified of. |
Method | _stop |
Immediately stop the CFRunLoop (which must be running!). |
Method | _unwatch |
Unregister a file descriptor with the CFRunLoop, or modify its state so that it's listening for only one notification (read or write) as opposed to both; used to implement removeReader and removeWriter... |
Method | _watch |
Register a file descriptor with the CFRunLoop, or modify its state so that it's listening for both notifications (read and write) rather than just one; used to implement addReader and addWriter. |
Instance Variable | _cfrunloop |
the CFRunLoop pyobjc object wrapped by this reactor. |
Instance Variable | _current |
if a CFTimer is currently scheduled with the CF run loop to run Twisted callLater calls, this is a reference to it. Otherwise, it is None |
Instance Variable | _fdmap |
a dictionary, mapping an integer (a file descriptor) to a 4-tuple of: |
Instance Variable | _idmap |
a dictionary, mapping the id() of an IReadDescriptor or IWriteDescriptor to a fd in _fdmap . Implemented in this manner so that we don't have to rely (even more) on the hashability of IReadDescriptor providers, and we know that they won't be collected since these are kept in sync with ... |
Instance Variable | _in |
Is CFRunLoopRun currently running? |
Instance Variable | _runner |
Undocumented |
Inherited from PosixReactorBase
:
Method | adopt |
Add an existing listening SOCK_DGRAM socket to the reactor to monitor for read and write readiness. |
Method | adopt |
No summary |
Method | adopt |
Create a new IListeningPort from an already-initialized socket. |
Method | connect |
Connect a client Protocol to a remote SSL socket. |
Method | connect |
Connect a TCP client. |
Method | connect |
Connect a client protocol to a UNIX socket. |
Method | connect |
Connects a ConnectedDatagramProtocol instance to a path. |
Method | listen |
Connects a given DatagramProtocol to the given numeric UDP port. |
Method | listen |
Connects a given protocol factory to the given numeric TCP/IP port. The connection is a SSL one, using contexts created by the context factory. |
Method | listen |
Connects a given protocol factory to the given numeric TCP/IP port. |
Method | listen |
Connects a given DatagramProtocol to the given numeric UDP port. |
Method | listen |
Listen on a UNIX socket. |
Method | listen |
Connects a given DatagramProtocol to the given path. |
Method | spawn |
Spawn a process, with a process protocol. |
Method | _handle |
Extend the basic signal handling logic to also support handling SIGCHLD to know when to try to reap child processes. |
Method | _remove |
Remove all readers and writers, and list of removed IReadDescriptor s and IWriteDescriptor s. |
Method | _uninstall |
If a child waker was created and installed, uninstall it now. |
Class Variable | _supported |
Undocumented |
Instance Variable | _child |
None or a reference to the _SIGCHLDWaker which is used to properly notice child process termination. |
Inherited from _SignalReactorMixin
(via PosixReactorBase
):
Method | run |
Undocumented |
Method | start |
Extend the base implementation in order to remember whether signal handlers should be installed later. |
Method | _really |
Extend the base implementation by also installing signal handlers, if self._installSignalHandlers is true. |
Instance Variable | _install |
A flag which indicates whether any signal handlers will be installed during startup. This includes handlers for SIGCHLD to monitor child processes, and SIGINT, SIGTERM, and SIGBREAK to stop the reactor. |
Inherited from _DisconnectSelectableMixin
(via PosixReactorBase
, _SignalReactorMixin
):
Method | _disconnect |
Utility function for disconnecting a selectable. |
Inherited from ReactorBase
(via PosixReactorBase
, _SignalReactorMixin
, _DisconnectSelectableMixin
):
Method | add |
See twisted.internet.interfaces.IReactorCore.addSystemEventTrigger. |
Method | call |
See twisted.internet.interfaces.IReactorFromThreads.callFromThread . |
Method | call |
See twisted.internet.interfaces.IReactorInThreads.callInThread . |
Method | call |
See twisted.internet.interfaces.IReactorCore.callWhenRunning. |
Method | disconnect |
Disconnect every reader, and writer in the system. |
Method | do |
Do one iteration over the readers and writers which have been added. |
Method | fire |
See twisted.internet.interfaces.IReactorCore.fireSystemEvent. |
Method | get |
See twisted.internet.interfaces.IReactorTime.getDelayedCalls |
Method | get |
See twisted.internet.interfaces.IReactorThreads.getThreadPool . |
Method | remove |
See twisted.internet.interfaces.IReactorCore.removeSystemEventTrigger. |
Method | resolve |
Return a Deferred that will resolve a hostname. |
Method | run |
Run all pending timed calls. |
Method | sig |
Handle a SIGBREAK interrupt. |
Method | sig |
Handle a SIGINT interrupt. |
Method | sig |
Handle a SIGTERM interrupt. |
Method | suggest |
See twisted.internet.interfaces.IReactorThreads.suggestThreadPoolSize . |
Method | timeout |
Determine the longest time the reactor may sleep (waiting on I/O notification, perhaps) before it must wake up to service a time-related event. |
Method | wake |
Wake up the event loop. |
Class Variable | __name__ |
Undocumented |
Class Variable | installed |
Undocumented |
Class Variable | seconds |
Get the current time in seconds. |
Instance Variable | running |
See IReactorCore.running |
Instance Variable | thread |
Undocumented |
Instance Variable | threadpool |
Undocumented |
Instance Variable | threadpool |
Undocumented |
Instance Variable | using |
Undocumented |
Method | _cancel |
Undocumented |
Method | _init |
Create the threadpool accessible with callFromThread. |
Method | _init |
Undocumented |
Method | _insert |
Undocumented |
Method | _stop |
Stop the reactor threadpool. This method is only valid if there is currently a threadpool (created by _initThreadPool ). It is not intended to be called directly; instead, it will be called by a shutdown trigger created in ... |
Class Variable | _lock |
Undocumented |
Instance Variable | _cancellations |
Undocumented |
Instance Variable | _event |
Undocumented |
Instance Variable | _exit |
See _ISupportsExitSignalCapturing._exitSignal |
Instance Variable | _internal |
Undocumented |
Instance Variable | _just |
A flag which is true between the time reactor.stop is called and the time the shutdown system event is fired. This is used to determine whether that event should be fired after each iteration through the mainloop... |
Instance Variable | _new |
Undocumented |
Instance Variable | _pending |
Undocumented |
Instance Variable | _register |
A flag controlling whether the reactor will register the thread it is running in as the I/O thread when it starts. If True, registration will be done, otherwise it will not be. |
Instance Variable | _started |
A flag which is true from the time reactor.run is called until the time reactor.run returns. This is used to prevent calls to reactor.run on a running reactor. This should be replaced with an explicit state machine. |
Instance Variable | _started |
Undocumented |
Instance Variable | _stopped |
A flag which is true between paired calls to reactor.run and reactor.stop. This should be replaced with an explicit state machine. |
Instance Variable | _threadpool |
Undocumented |
Inherited from PluggableResolverMixin
(via PosixReactorBase
, _SignalReactorMixin
, _DisconnectSelectableMixin
, ReactorBase
):
Method | install |
See IReactorPluggableNameResolver . |
Method | install |
See IReactorPluggableResolver . |
Instance Variable | resolver |
The installed IResolverSimple . |
Property | name |
Implementation of read-only IReactorPluggableNameResolver.nameResolver . |
Instance Variable | _name |
The installed IHostnameResolver . |
Override installWaker in order to use _WakerPlus
; otherwise this should be exactly the same as the parent implementation.
Emulate the behavior of iterate() for things that want to call it, by letting the loop run for a little while and then scheduling a timed call to exit it.
Run the runner (CFRunLoopRun or something that calls it), which runs the run loop until crash() is called.
Convert a kCFSocket... constant to an index into the read/write state list (_READ or _WRITE) (the 4th element of the value of self._fdmap).
Parameters | |
flag | kCFSocketReadCallBack or kCFSocketWriteCallBack |
Returns | |
_READ or _WRITE |
Override PosixReactorBase
's implementation of IDelayedCall.reset
so that it will immediately reschedule. Normally _moveCallLaterSooner depends on the fact that runUntilCurrent is always run before the mainloop goes back to sleep, so this forces it to immediately recompute how long the loop needs to stay asleep.
Schedule a call to self.runUntilCurrent. This will cancel the currently scheduled call if it is already scheduled.
Parameters | |
force:bool | Even if there are no timed calls, make sure that runUntilCurrent runs immediately (in a 0-seconds-from-now CFRunLoopTimer). This is necessary for calls which need to trigger behavior of runUntilCurrent other than running timed calls, such as draining the thread call queue or calling crash() when the appropriate flags are set. |
The socket callback issued by CFRunLoop. This will issue doRead or doWrite calls to the IReadDescriptor
and IWriteDescriptor
registered with the file descriptor that we are being notified of.
Parameters | |
cf | The CFSocket which has got some activity. |
callback | The type of activity that we are being notified of. Either kCFSocketReadCallBack or kCFSocketWriteCallBack. |
ignored | Unused, because this is not used for either of the callback types we register for. |
ignored | Unused, because this is not used for either of the callback types we register for. |
context | The data associated with this callback by CFSocketCreateWithNative (in CFReactor._watchFD). A 2-tuple of (int, CFRunLoopSource). |
Unregister a file descriptor with the CFRunLoop, or modify its state so that it's listening for only one notification (read or write) as opposed to both; used to implement removeReader and removeWriter.
Parameters | |
fd:int | a file descriptor |
descr | an IReadDescriptor or IWriteDescriptor |
flag | kCFSocketWriteCallBack kCFSocketReadCallBack |
Register a file descriptor with the CFRunLoop, or modify its state so that it's listening for both notifications (read and write) rather than just one; used to implement addReader and addWriter.
Parameters | |
fd:int | The file descriptor. |
descr | the IReadDescriptor or IWriteDescriptor |
flag | the flag to register for callbacks on, either kCFSocketReadCallBack or kCFSocketWriteCallBack |
if a CFTimer is currently scheduled with the CF run loop to run Twisted callLater calls, this is a reference to it. Otherwise, it is None
a dictionary, mapping an integer (a file descriptor) to a 4-tuple of:
- source: a CFRunLoopSource; the source associated with this socket.
- socket: a CFSocket wrapping the file descriptor.
- descriptor: an
IReadDescriptor
and/orIWriteDescriptor
provider. - read-write: a 2-list of booleans: respectively, whether this descriptor is currently registered for reading or registered for writing.
a dictionary, mapping the id() of an IReadDescriptor
or IWriteDescriptor
to a fd in _fdmap
. Implemented in this manner so that we don't have to rely (even more) on the hashability of IReadDescriptor
providers, and we know that they won't be collected since these are kept in sync with _fdmap. Necessary because the .fileno() of a file descriptor may change at will, so we need to be able to look up what its file descriptor used to be, so that we can look it up in _fdmap