API Reference

Plugin()
intake_pcap.source.PCAPSource(urlpath, …)	Attributes:
intake_pcap.packet.IPPacket(data)	Attributes:
intake_pcap.stream.LiveStream(interface[, …])	Attributes:
intake_pcap.stream.OfflineStream(path[, …])	Attributes:
intake_pcap.stream.PacketStream(reader, …)	Attributes:

class intake_pcap.Plugin

Methods

open(urlpath, **kwargs)

Parameters: urlpath : str Absolute or relative path to source files that can contain shell-style wildcards.

separate_base_kwargs

open(urlpath, **kwargs)

Parameters:

urlpath : str

Absolute or relative path to source files that can contain shell-style wildcards.

kwargs : dict

Additional parameters to pass to intake_pcap.stream.PacketStream subclass.

class intake_pcap.source.PCAPSource(urlpath, pcap_kwargs, metadata)

Attributes:

plot

Methods

close()	Close open resources corresponding to this data source.
discover()	Open resource and populate the source attributes.
read()	Load entire dataset into a container and return it
read_chunked()	Return iterator over container fragments of data source
read_partition(i)	Return a (offset_tuple, container) corresponding to i-th partition.
to_dask()	Return a dask container for this data source

class intake_pcap.packet.IPPacket(data)

Attributes:

destination_ip_address

destination_ip_port

destination_mac_address

ethernet_protocol

ip_protocol

source_ip_address

source_ip_port

source_mac_address

class intake_pcap.stream.LiveStream(interface, protocol=None, payload=False, max_packet=65536, timeout=1000)

Attributes:

dtype

Methods

set_filter(protocol)

Filters all IP traffic except packets matching given protocol.

to_dataframe

class intake_pcap.stream.OfflineStream(path, protocol=None, payload=False)

Attributes:

dtype

Methods

set_filter(protocol)

Filters all IP traffic except packets matching given protocol.

to_dataframe

class intake_pcap.stream.PacketStream(reader, protocol, payload)

Attributes:

dtype

Methods

set_filter(protocol)

Filters all IP traffic except packets matching given protocol.

to_dataframe

set_filter(protocol)

Filters all IP traffic except packets matching given protocol.

Parameters:

protocol : str

Show only traffic for given IP protocol.

Allowed values are icmp, icmp6, igmp, igrp, pim, ah, esp, vrrp, udp, and tcp. If None, all traffic is shown.