twisted.pair.tuntap._IInputOutputSystem : API documentation

interface documentation

class twisted.pair.tuntap._IInputOutputSystem(Interface): (source)

Known implementations: twisted.pair.testing.MemoryIOSystem

View In Hierarchy

An interface for performing some basic kinds of I/O (particularly that I/O which might be useful for twisted.pair.tuntap-using code).

Attribute	O_RDWR
Attribute	O_NONBLOCK
Attribute	O_CLOEXEC
Method	open
Method	ioctl
Method	read
Method	write
Method	close
Method	sendUDP	Send a datagram to a certain address.
Method	receiveUDP	Return a socket which can be used to receive datagrams sent to the given address.

O_RDWR = (source)

See Also os.O_RDWR

O_NONBLOCK = (source)

See Also os.O_NONBLOCK

O_CLOEXEC = (source)

See Also os.O_CLOEXEC

def open(filename, flag, mode=511): (source)

See Also os.open

def ioctl(fd, opt, arg=None, mutate_flag=None): (source)

See Also fcntl.ioctl

def read(fd, limit): (source)

See Also os.read

def write(fd, data): (source)

See Also os.write

def close(fd): (source)

See Also os.close

def sendUDP(datagram, address): (source)

Send a datagram to a certain address.

Parameters	datagram	The payload of a UDP datagram to send. (type: `bytes`)
	address	The destination to which to send the datagram. (type: `tuple` of (`bytes`, `int`))
Returns	The local address from which the datagram was sent. (type: `tuple` of (`bytes`, `int`))

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

Return a socket which can be used to receive datagrams sent to the given address.

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

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.