vspyx.TCPIP

Package Contents

Classes

AddressFamily	Enum where members are also (and must be) ints
CurlRequest	CurlRequest
CurlRequestAuthentication	CurlRequestAuthentication
Follower	Represents TCP/IP packet handling object
IPDatagramPoint	IPDatagramPoint
IPDiscoveryProcessor	IPDiscoveryProcessor
IPProtocol	Represents a protocol type (TCP or UDP)
IPv4Follower	Represents raw IP data handling and processing
IPv4TCPHostSocket	IPv4TCPHostSocket
IPv6Follower	A PointProcessor which creates IPDatagramPoints from IPv6 traffic.
IPv6TCPHostSocket	IPv6TCPHostSocket
Interface	Represents an Ethernet interface
Module	Represents a TCP/IP module interface
Network	Represents a managed collection of network interfaces
Protocol	Enum where members are also (and must be) ints
Socket	Represents a standard TCP/UDP socket object
SocketInputOutputStream	SocketInputOutputStream
SocketStateChangePoint	SocketStateChangePoint
SocketType	Enum where members are also (and must be) ints
TCPACKPoint	TCPACKPoint
TCPFollower	Represents TCP packet reconstruction handling and connection state management
TCPHostSocket	TCPHostSocket
TCPUDPEndpoint	Represents a TCP/UDP endpoint identifier
TLSHostSocket	TLSHostSocket
UDPFollower	Watches for routing layer (IPv4 or IPv6) IPDatagramPoints

class vspyx.TCPIP.AddressFamily

Bases: enum.IntEnum

Enum where members are also (and must be) ints

IPv4 = 1

IPv6 = 2

Unspecified = 0

class vspyx.TCPIP.CurlRequest

CurlRequest

class HttpVersion

Bases: enum.IntEnum

Enum where members are also (and must be) ints

HTTP_1_0 = 1

HTTP_1_1 = 2

class RequestMethod

Bases: enum.IntEnum

Enum where members are also (and must be) ints

GET = 0

POST = 1

PUT = 2

class TlsVersion

Bases: enum.IntEnum

Enum where members are also (and must be) ints

Insecure = 0

TLS_1_2 = 6

class UploadStats

UploadStats

totalTime :int

uploadSpeed :int

LastHttpVersionUsed :CurlRequest.HttpVersion

Download(self, url: str) → vspyx.Core.BytesView

Download(self, url: str, responseCode: int) → vspyx.Core.BytesView

Download(self, url: str, responseCode: int, requestMethod: CurlRequest.RequestMethod) → vspyx.Core.BytesView

Download(self, url: str, responseCode: int, requestMethod: CurlRequest.RequestMethod, postField: str) → vspyx.Core.BytesView

Download(self, url: str, outputStream: vspyx.IO.OutputStream) → int

Download(self, url: str, outputStream: vspyx.IO.OutputStream, responseCode: int) → int

Download(self, url: str, outputStream: vspyx.IO.OutputStream, responseCode: int, requestMethod: CurlRequest.RequestMethod) → int

Download(self, url: str, outputStream: vspyx.IO.OutputStream, responseCode: int, requestMethod: CurlRequest.RequestMethod, postField: str) → int

RequestVerified(self) → bool

SetTimeout(self, timeout: Any) → Any

ShowProgress(self, showProgress: bool) → Any

Upload(self, url: str, srcBuffer: vspyx.Core.BytesView) → CurlRequest.UploadStats

Upload(self, url: str, srcBuffer: vspyx.Core.BytesView, responseCode: int) → CurlRequest.UploadStats

Upload(self, url: str, inputStream: vspyx.IO.InputStream) → CurlRequest.UploadStats

Upload(self, url: str, inputStream: vspyx.IO.InputStream, responseCode: int) → CurlRequest.UploadStats

class vspyx.TCPIP.CurlRequestAuthentication

CurlRequestAuthentication

CACertificate :str

Certificate :str

Key :str

HasAllCredentials(self) → bool

SetCACert(self, caCert: str) → Any

class vspyx.TCPIP.Follower

Bases: vspyx.Runtime.Component

Represents TCP/IP packet handling object

class ConnectionStateChange

Bases: enum.IntEnum

Enum where members are also (and must be) ints

Closed = 2

Error = 0

OpenedOrDetected = 1

class FilterMode

Bases: enum.IntEnum

Enum where members are also (and must be) ints

AllButFilters = 1

OnlyFilters = 0

OnTCPConnectionStateChanged :vspyx.Core.Callback_43999c9b56

OnTCPData :vspyx.Core.Callback_bf209425cf

AddFilter(self, ipVersion: vspyx.Core.IPVersion, ipProtocol: IPProtocol, address: str, port: int) → Any

AddFilter(self, ipVersion: vspyx.Core.IPVersion, ipProtocol: IPProtocol, address: str, port: int, otherAddress: Any) → Any

Attach(self, channel: vspyx.Communication.EthernetChannel) → Any

ClearFilters(self) → Any

Detach(self) → Any

GetFilterMode(self) → Follower.FilterMode

static New() → Follower

SetFilterMode(self, set: Follower.FilterMode) → Any

class vspyx.TCPIP.IPDatagramPoint

Bases: vspyx.Communication.DatagramPoint

IPDatagramPoint

IsRoutingLayer :bool

IsRoutingLayerTag :str

GetAttribute(self, type: str) → vspyx.Runtime.Value

Get an attribute of this point by its tag

If the attribute doesn’t exist, an empty Runtime::Value will be returned.

class vspyx.TCPIP.IPDiscoveryProcessor

Bases: vspyx.Communication.PointProcessor

IPDiscoveryProcessor

EphemeralPortRange :Any

Get the range [min, max] of ports which are considered ephemeral.

Ephemeral ports will be coalesced into a single Traceable, as long as both ports are not in the ephemeral range.

static New() → IPDiscoveryProcessor

class vspyx.TCPIP.IPProtocol

Bases: enum.IntEnum

Represents a protocol type (TCP or UDP)

TCP = 6

UDP = 17

class vspyx.TCPIP.IPv4Follower

Bases: vspyx.Communication.PointProcessor

Represents raw IP data handling and processing

OnRawDatagram :vspyx.Core.Callback_cc25a8fde8

VerifyChecksums :bool

static New() → IPv4Follower

ProcessDatagram(self, data: vspyx.Core.BytesView) → Any

class vspyx.TCPIP.IPv4TCPHostSocket

Bases: TCPHostSocket

IPv4TCPHostSocket

class vspyx.TCPIP.IPv6Follower

Bases: vspyx.Communication.PointProcessor

A PointProcessor which creates IPDatagramPoints from IPv6 traffic.

Does not yet reassemble fragmented datagrams.

static New() → IPv6Follower

class vspyx.TCPIP.IPv6TCPHostSocket

Bases: TCPHostSocket

IPv6TCPHostSocket

class vspyx.TCPIP.Interface

Bases: vspyx.Runtime.Component

Represents an Ethernet interface

AttachedChannel :vspyx.Communication.EthernetChannel

IPv4Address :vspyx.Core.IPv4Address

IPv4Gateway :vspyx.Core.IPv4Address

IPv4Netmask :vspyx.Core.IPv4Address

InterfaceID :int

MACAddress :str

Network :Network

OnConfigurationMutation :vspyx.Core.Callback_634bd5c449

OnEgress :vspyx.Core.Callback_92f40c8a1f

Up :bool

AddARPEntry(self, ip: str, mac: str) → Any

Attach(self, channel: vspyx.Communication.EthernetChannel) → Any

AutoconfigureIPv6Address(self, prefix: vspyx.Core.IPv6Address) → bool

BindToIPv6Address(self, set: vspyx.Core.IPv6Address) → bool

ClearARPTable(self) → Any

CloneConfiguration(self) → Any

Return the immutable configuration of this object.

Except for the resolver parenting relationship, this represents the entire serializable state of the object.

Detach(self) → Any

GetARPTableEntry(self, ip: str) → str

Ingress(self, frame: vspyx.Frames.Frame) → vspyx.Communication.Connector.IngressActions

static New() → Interface

static New(config: Any) → Interface

RemoveARPEntry(self, ip: str) → bool

SendARPRequest(self, ip: str) → Any

class vspyx.TCPIP.Module

Bases: vspyx.Core.Module

Represents a TCP/IP module interface

AddNetwork(self, network: Network) → Any

class vspyx.TCPIP.Network

Bases: vspyx.Communication.PointProcessor

Represents a managed collection of network interfaces

OnConfigurationMutation :vspyx.Core.Callback_634bd5c449

AddInterface(self, iface: Interface) → Any

CloneConfiguration(self) → Any

Return the immutable configuration of this object.

Except for the resolver parenting relationship, this represents the entire serializable state of the object.

static New() → Network

static New(config: Any) → Network

NewIPv4TCPSocket(self) → Socket

NewIPv4UDPSocket(self) → Socket

NewIPv6TCPSocket(self) → Socket

NewIPv6UDPSocket(self) → Socket

NewRawIPv4Socket(self, protocol: Protocol) → Socket

NewRawIPv6Socket(self, protocol: Protocol) → Socket

NewSocket(self, af: AddressFamily, type: SocketType, protocol: Protocol) → Socket

class vspyx.TCPIP.Protocol

Bases: enum.IntEnum

Enum where members are also (and must be) ints

ICMPv4 = 1

ICMPv6 = 58

IGMP = 2

IPv4 = 0

IPv6 = 41

TCP = 6

UDP = 17

class vspyx.TCPIP.Socket

Bases: vspyx.Core.Object

Represents a standard TCP/UDP socket object

class Accepted

Accepted

AcceptedSocket :Socket

Endpoint :TCPUDPEndpoint

class ReceivedFrom

ReceivedFrom

Endpoint :TCPUDPEndpoint

Received :vspyx.Core.BytesView

class State

Bases: enum.IntEnum

Enum where members are also (and must be) ints

CLOSED = 0

CLOSING = 1

CONNECTED = 3

CONNECTING = 2

LISTENING = 4

ActivityEvent :vspyx.Core.Event

IPProtocol :IPProtocol

IPVersion :vspyx.Core.IPVersion

IsClosed :bool

Linger :bool

LingerTime :Any

Name :str

NoDelay :bool

PeerName :str

Accept(self) → Any

Bind(self, address: str, port: Any) → Any

Bind(self, address: str, port: Any, iface: Interface) → Any

Close(self) → Any

Connect(self, address: str, port: int) → Any

Connect(self, address: str, port: int, iface: Interface) → Any

GetState(self) → Socket.State

Listen(self, maxIncomingConnections: int) → Any

Receive(self, maxReceiveSize: int) → Any

ReceiveFrom(self, maxReceiveSize: int) → Any

Send(self, data: vspyx.Core.BytesView) → int

Send(self, data: vspyx.Core.BytesView, outOfBand: bool) → int

SendTo(self, data: vspyx.Core.BytesView, address: str, port: Any) → int

SendTo(self, data: vspyx.Core.BytesView, address: str, port: Any, outOfBand: bool) → int

SendTo(self, data: vspyx.Core.BytesView, address: str, port: Any, outOfBand: bool, iface: Interface) → int

Shutdown(self) → Any

Shutdown(self, readDisabled: bool) → Any

Shutdown(self, readDisabled: bool, writeDisabled: bool) → Any

class vspyx.TCPIP.SocketInputOutputStream

Bases: vspyx.IO.InputOutputStream

SocketInputOutputStream

Connect(self, hostname: str, port: int) → Any

class vspyx.TCPIP.SocketStateChangePoint

Bases: vspyx.Runtime.Point

SocketStateChangePoint

Interesting :vspyx.Runtime.Point.Interesting

GetAttribute(self, type: str) → vspyx.Runtime.Value

Get an attribute of this point by its tag

If the attribute doesn’t exist, an empty Runtime::Value will be returned.

class vspyx.TCPIP.SocketType

Bases: enum.IntEnum

Enum where members are also (and must be) ints

Datagram = 2

Raw = 3

Stream = 1

Unspecified = 0

class vspyx.TCPIP.TCPACKPoint

Bases: vspyx.Runtime.Point

TCPACKPoint

Interesting :vspyx.Runtime.Point.Interesting

GetAttribute(self, type: str) → vspyx.Runtime.Value

Get an attribute of this point by its tag

If the attribute doesn’t exist, an empty Runtime::Value will be returned.

class vspyx.TCPIP.TCPFollower

Bases: vspyx.Communication.PointProcessor

Represents TCP packet reconstruction handling and connection state management

OnConnectionStateChanged :vspyx.Core.Callback_43999c9b56

OnConnectionStateChangedTracked :vspyx.Core.Callback_612855dbcb

OnData :vspyx.Core.Callback_bf209425cf

OnTrackedData :vspyx.Core.Callback_14d0a27fbb

static New() → TCPFollower

ProcessIPDatagram(self, ipVersion: vspyx.Core.IPVersion, data: vspyx.Core.BytesView) → Any

class vspyx.TCPIP.TCPHostSocket

Bases: Socket

TCPHostSocket

ActivityEvent :vspyx.Core.Event

AvailableBytes :int

IsClosed :bool

Linger :bool

LingerTime :Any

NoDelay :bool

State :Socket.State

Close(self) → Any

Listen(self, maxIncomingConnections: int) → Any

Receive(self, maxReceiveSize: int) → Any

Send(self, data: vspyx.Core.BytesView, outOfBand: bool) → int

Shutdown(self, readDisabled: bool, writeDisabled: bool) → Any

class vspyx.TCPIP.TCPUDPEndpoint

Represents a TCP/UDP endpoint identifier

DestinationAddress :vspyx.Core.IPAddress

DestinationPort :int

Proto :IPProtocol

SourceAddress :vspyx.Core.IPAddress

SourcePort :int

Version :vspyx.Core.IPVersion

__eq__(self, rhs: TCPUDPEndpoint) → bool

Return self==value.

__str__(self) → str

Return str(self).

class vspyx.TCPIP.TLSHostSocket

Bases: Socket

TLSHostSocket

class vspyx.TCPIP.UDPFollower

Bases: vspyx.Communication.PointProcessor

Watches for routing layer (IPv4 or IPv6) IPDatagramPoints and creates UDP layer IPDatagramPoints, optionally checking the checksum.

static New() → UDPFollower