class twisted.pair.tuntap.TuntapPort(abstract.FileDescriptor): (source)
Implements interfaces: twisted.internet.interfaces.IListeningPort
A Port that reads and writes packets from/to a TUN/TAP-device.
| Class Variable | maxThroughput | Undocumented |
| Method | __init__ | |
| Instance Variable | ethernet | Undocumented |
| Instance Variable | interface | Undocumented |
| Instance Variable | protocol | Undocumented |
| Instance Variable | maxPacketSize | Undocumented |
| Instance Variable | logstr | Undocumented |
| Method | __repr__ | Undocumented |
| Method | startListening | Create and bind my socket, and begin listening on it. |
| Instance Variable | connected | Undocumented |
| Method | fileno | File Descriptor number for select(). |
| Method | doRead | Called when my socket is ready for reading. |
| Method | write | Write the given data as a single datagram. |
| Method | writeSequence | Write a datagram constructed from a list of bytes. |
| Method | stopListening | Stop accepting connections on this port. |
| Instance Variable | disconnecting | Undocumented |
| Method | loseConnection | Close this tunnel. Use TuntapPort.stopListening instead. |
| Method | connectionLost | Cleans up my socket. |
| Method | logPrefix | Returns the name of my class, to prefix log entries with. |
| Method | getHost | Get the local address of this TuntapPort. |
| Instance Variable | _mode | Undocumented |
| Instance Variable | _system | Undocumented |
| Method | _openTunnel | Open the named tunnel using the given mode. |
| Method | _bindSocket | Open the tunnel. |
| Instance Variable | _fileno | Undocumented |
| Instance Variable | _stoppedDeferred | Undocumented |
Inherited from FileDescriptor:
| Instance Variable | disconnected | Undocumented |
| Instance Variable | dataBuffer | Undocumented |
| Instance Variable | offset | Undocumented |
| Class Variable | SEND_LIMIT | Undocumented |
| Instance Variable | reactor | Undocumented |
| Instance Variable | producer | Undocumented |
| Method | writeSomeData | Write as much as possible of the given data, immediately. |
| Method | doWrite | Called when data can be written. |
| Instance Variable | producerPaused | Undocumented |
| Method | writeConnectionLost | Undocumented |
| Method | readConnectionLost | Undocumented |
| Method | getPeer | Undocumented |
| Method | loseWriteConnection | Undocumented |
| Method | stopReading | Stop waiting for read availability. |
| Method | stopWriting | Stop waiting for write availability. |
| Method | startReading | Start waiting for read availability. |
| Method | startWriting | Start waiting for write availability. |
| Class Variable | bufferSize | Undocumented |
| Method | stopConsuming | Stop consuming data. |
| Method | resumeProducing | Undocumented |
| Method | pauseProducing | Undocumented |
| Method | stopProducing | Undocumented |
| Instance Variable | _writeDisconnecting | Undocumented |
| Instance Variable | _writeDisconnected | Undocumented |
| Instance Variable | _tempDataBuffer | Undocumented |
| Instance Variable | _tempDataLen | Undocumented |
| Method | _postLoseConnection | Called after a loseConnection(), when all data has been written. |
| 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. |
Inherited from _ConsumerMixin (via FileDescriptor):
| Instance Variable | streamingProducer | bool or int |
| Method | registerProducer | Register to receive data from a producer. |
| Method | unregisterProducer | Stop consuming data from a producer, without disconnecting. |
Inherited from _LogOwner (via FileDescriptor):
| Method | _getLogPrefix | Determine the log prefix to use for messages related to applicationObject, which may or may not be an interfaces.ILoggingContext provider. |
| Parameters | interface | Undocumented |
| proto | Undocumented | |
| maxPacketSize | Undocumented | |
| reactor | An IReactorFDSet provider which this descriptor will use to get readable and writeable event notifications. If no value is given, the global reactor will be used. | |
| system | Undocumented |
Create and bind my socket, and begin listening on it.
This must be called after creating a server to begin listening on the specified tunnel.
Open the named tunnel using the given mode.
| Parameters | name | The name of the tunnel to open. (type: bytes) |
| mode | Flags from TunnelFlags with exactly one of TunnelFlags.IFF_TUN or TunnelFlags.IFF_TAP set. | |
| Returns | A _TunnelDescription representing the newly opened tunnel. | |
File Descriptor number for select().
This method must be overridden or assigned in subclasses to indicate a valid file descriptor for the operating system.
Write the given data as a single datagram.
| Parameters | datagram | The data that will make up the complete datagram to be written. (type: bytes) |
Stop accepting connections on this port.
This will shut down my socket and call self.connectionLost().
| Returns | A Deferred that fires when this port has stopped. | |
Close this tunnel. Use TuntapPort.stopListening instead.
Cleans up my socket.
| Parameters | reason | Ignored. Do not use this. |
Get the local address of this TuntapPort.
| Returns | A TunnelAddress which describes the tunnel device to which this object is bound. (type: TunnelAddress) | |