org.apache.drill.exec.store.pcapng

Class PcapngBatchReader

java.lang.Object

org.apache.drill.exec.store.pcapng.PcapngBatchReader

All Implemented Interfaces:

ManagedReader<FileScanFramework.FileSchemaNegotiator>

public class PcapngBatchReader
extends Object
implements ManagedReader<FileScanFramework.FileSchemaNegotiator>

Constructor Summary

Constructors

Constructor and Description
PcapngBatchReader(PcapFormatConfig config, EasySubScan scan)

Method Summary

Modifier and Type	Method and Description
void	close() Release resources.
boolean	next() The default of the `stat` parameter is false, which means that the packet data is parsed and returned, but if true, will return the statistics data about the each pcapng file only (consist of the information about collect devices and the summary of the packet data above).
boolean	open(FileScanFramework.FileSchemaNegotiator negotiator) Setup the record reader.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PcapngBatchReader

public PcapngBatchReader(PcapFormatConfig config,
                         EasySubScan scan)

Method Detail

open

public boolean open(FileScanFramework.FileSchemaNegotiator negotiator)

Description copied from interface: ManagedReader

Setup the record reader. Called just before the first call to next(). Allocate resources here, not in the constructor. Example: open files, allocate buffers, etc.

Specified by:

open in interface ManagedReader<FileScanFramework.FileSchemaNegotiator>

Parameters:

negotiator - mechanism to negotiate select and table schemas, then create the row set reader used to load data into value vectors

Returns:

true if the reader is open and ready to read (possibly no) rows. false for a "soft" failure in which no schema or data is available, but the scanner should not fail, it should move onto another reader

next

public boolean next()

The default of the `stat` parameter is false, which means that the packet data is parsed and returned, but if true, will return the statistics data about the each pcapng file only (consist of the information about collect devices and the summary of the packet data above). In addition, a pcapng file contains a single Section Header Block (SHB), a single Interface Description Block (IDB) and a few Enhanced Packet Blocks (EPB).

 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 | SHB | IDB | EPB | EPB |    ...    | EPB |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 

https://pcapng.github.io/pcapng/draft-tuexen-opsawg-pcapng.html#name-physical-file-layout

Specified by:

next in interface ManagedReader<FileScanFramework.FileSchemaNegotiator>

Returns:

true if more data may be available (and so next() should be called again, false to indicate that EOF was reached

close

public void close()

Description copied from interface: ManagedReader

Release resources. Called just after a failure, when the scanner is cancelled, or after next() returns EOF. Release all resources and close files. Guaranteed to be called if open() returns normally; will not be called if open() throws an exception.

Specified by:

close in interface ManagedReader<FileScanFramework.FileSchemaNegotiator>