t.p.t.Tunnel(object) : class documentation

Part of twisted.pair.testing View Source View In Hierarchy

An in-memory implementation of a tun or tap device.
Method __init__
Method blocking If the file descriptor for this tunnel is open in blocking mode, True. False otherwise.
Method closeOnExec If the file descriptor for this this tunnel is marked as close-on-exec, True. False otherwise.
Method addToReadBuffer Deliver a datagram to this tunnel's read buffer. This makes it available to be read later using the read method.
Method read Read a datagram out of this tunnel.
Method write Write a datagram into this tunnel.
Class Variable _DEVICE_NAME A string representing the conventional filesystem entry for the tunnel factory character special device. (type: bytes)
_DEVICE_NAME =
A string representing the conventional filesystem entry for the tunnel factory character special device. (type: bytes)
def __init__(self, system, openFlags, fileMode): (source)
ParameterssystemAn _IInputOutputSystem provider to use to perform I/O.
openFlagsAny flags to apply when opening the tunnel device. See os.O_*. (type: int)
fileModeignored
@property
def blocking(self): (source)
If the file descriptor for this tunnel is open in blocking mode, True. False otherwise.
@property
def closeOnExec(self): (source)
If the file descriptor for this this tunnel is marked as close-on-exec, True. False otherwise.
def addToReadBuffer(self, datagram): (source)
Deliver a datagram to this tunnel's read buffer. This makes it available to be read later using the read method.
ParametersdatagramThe IPv4 datagram to deliver. If the mode of this tunnel is TAP then ethernet framing will be added automatically. (type: bytes)
def read(self, limit): (source)
Read a datagram out of this tunnel.
ParameterslimitThe maximum number of bytes from the datagram to return. If the next datagram is larger than this, extra bytes are dropped and lost forever. (type: int)
ReturnsThe datagram which was read from the tunnel. If the tunnel mode does not include TunnelFlags.IFF_NO_PI then the datagram is prefixed with a 4 byte PI header. (type: bytes)
RaisesOSErrorAny of the usual I/O problems can result in this exception being raised with some particular error number set.
IOErrorAny of the usual I/O problems can result in this exception being raised with some particular error number set.
def write(self, datagram): (source)
Write a datagram into this tunnel.
ParametersdatagramThe datagram to write. (type: bytes)
ReturnsThe number of bytes of the datagram which were written. (type: int)
RaisesIOErrorAny of the usual I/O problems can result in this exception being raised with some particular error number set.
API Documentation for Twisted, generated by pydoctor at 2014-05-12 18:27:00.