twisted.pair.testing.MemoryIOSystem : API documentation

_devices = (source)

(type: dict)

_openFiles = (source)

(type: dict)

permissions = (source)

(type: set[str])

_counter = (source)

(type: int)

O_RDWR = (source)

from twisted.pair.tuntap._IInputOutputSystem

See Also os.O_CLOEXEC

def __init__(self): (source)

Undocumented

def getTunnel(self, port): (source)

Get the Tunnel object associated with the given TuntapPort.

Parameters	port	A `TuntapPort` previously initialized using this `MemoryIOSystem`.
Returns	The tunnel object created by a prior use of `open` on this object on the tunnel special device file. (type: `Tunnel`)

def registerSpecialDevice(self, name, cls): (source)

Specify a class which will be used to handle I/O to a device of a particular name.

Parameters	name	The filesystem path name of the device. (type: `bytes`)
	cls	A class (like `Tunnel`) to instantiated whenever this device is opened.

@_privileged
def open(self, name, flags, mode=None): (source)

from twisted.pair.tuntap._IInputOutputSystem

A replacement for os.open. This initializes state in this MemoryIOSystem which will be reflected in the behavior of the other file descriptor-related methods (eg MemoryIOSystem.read, MemoryIOSystem.write, etc).

Parameters	name	A string giving the name of the file to open. (type: `bytes`)
	flags	The flags with which to open the file. (type: `int`)
	mode	The mode with which to open the file. (type: `int`)
Returns	A file descriptor associated with the newly opened file description. (type: `int`)
Raises	OSError	With `ENOSYS` if the file is not a recognized special device file.

def read(self, fd, limit): (source)

from twisted.pair.tuntap._IInputOutputSystem

Try to read some bytes out of one of the in-memory buffers which may previously have been populated by write.

See Also fcntl.ioctl

def sendUDP(self, datagram, address): (source)

from twisted.pair.tuntap._IInputOutputSystem

Write an ethernet frame containing an ip datagram containing a udp datagram containing the given payload, addressed to the given address, to a tunnel device previously opened on this I/O system.

Parameters	datagram	A UDP datagram payload to send. (type: `bytes`)
	address	The destination to which to send the datagram. (type: `tuple` of (`bytes`, `int`))
Returns	A two-tuple giving the address from which gives the address from which the datagram was sent. (type: `tuple` of (`bytes`, `int`))

def receiveUDP(self, fileno, host, port): (source)

from twisted.pair.tuntap._IInputOutputSystem

Get a socket-like object which can be used to receive a datagram sent from the given address.

Parameters	fileno	A file descriptor representing a tunnel device which the datagram will be received via. (type: `int`)
	host	The IPv4 address to which the datagram was sent. (type: `bytes`)
	port	The UDP port number to which the datagram was sent. received. (type: `int`)
Returns	A `socket.socket`-like object which can be used to receive the specified datagram.

Instance Variable	permissions
Class Variable	O_RDWR
Class Variable	O_NONBLOCK
Class Variable	O_CLOEXEC
Method	__init__	Undocumented
Method	getTunnel	Get the `Tunnel` object associated with the given `TuntapPort`.
Method	registerSpecialDevice	Specify a class which will be used to handle I/O to a device of a particular name.
Method	open	No summary
Method	read	Try to read some bytes out of one of the in-memory buffers which may previously have been populated by `write`.
Method	write	Try to add some bytes to one of the in-memory buffers to be accessed by a later `read` call.
Method	close	Discard the in-memory buffer and other in-memory state for the given file descriptor.
Method	ioctl	Perform some configuration change to the in-memory state for the given file descriptor.
Method	sendUDP	Write an ethernet frame containing an ip datagram containing a udp datagram containing the given payload, addressed to the given address, to a tunnel device previously opened on this I/O system.
Method	receiveUDP	Get a socket-like object which can be used to receive a datagram sent from the given address.
Instance Variable	_devices
Instance Variable	_openFiles
Instance Variable	_counter