twisted.pair.test.test_tuntap.TapHelper

class documentation

class TapHelper: (source)

View In Hierarchy

A helper for tests of tap-related functionality (ethernet-level tunnels).

Method __init__ No summary
Method encapsulate Construct an ethernet frame containing an ip datagram containing a udp datagram containing the given application-level payload.
Method parser Get a function for parsing a datagram read from a tap device.
Instance Variable pi Undocumented
Instance Variable tunnelLocal Undocumented
Instance Variable tunnelRemote Undocumented
Property TUNNEL_TYPE Undocumented
def __init__(self, tunnelRemote, tunnelLocal, pi): (source)
Parameters
tunnelRemote:bytesThe source address for UDP datagrams originated from this helper. This is an IPv4 dotted-quad string.
tunnelLocal:bytesThe destination address for UDP datagrams originated from this helper. This is an IPv4 dotted-quad string.
pi:boolA flag indicating whether this helper will generate and consume a protocol information (PI) header.
def encapsulate(self, source, destination, payload): (source)

Construct an ethernet frame containing an ip datagram containing a udp datagram containing the given application-level payload.

Parameters
source:intThe source port for the UDP datagram being encapsulated.
destination:intThe destination port for the UDP datagram being encapsulated.
payload:bytesThe application data to include in the udp datagram.
Returns
bytesAn ethernet frame.
def parser(self): (source)

Get a function for parsing a datagram read from a tap device.

Returns
A function which accepts a datagram exactly as might be read from a tap device. The datagram is expected to ultimately carry a UDP datagram. When called, it returns a list of tuples. Each tuple has the UDP application data as the first element and the sender address as the second element.
pi = (source)

Undocumented

tunnelLocal = (source)

Undocumented

tunnelRemote = (source)

Undocumented

@property
TUNNEL_TYPE = (source)

Undocumented