at.jku.fim.rubanetra.pcap

Interface PcapHandler<T extends PcapActivityListener>

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

PcapFileHandler

public interface PcapHandler<T extends PcapActivityListener>
extends Closeable

Method Summary

Modifier and Type	Method and Description
void	addPcapProcessor(T processor) Adds a custom listener or processor to the set of already registered listeners.
void	close() Closes the underlying input streams (if not closed already) and releases any system resources associated with it.
PcapActivity	getCurrentPcapActivity() A convenience method that provides a reference to the currently processed PcapActivity, i.e.
boolean	readNextPcapEntry(T processor) Read the next Pcap entry from the respective input stream.
void	removePcapProcessor(T processor) Removes a custom listener or processor from the set of already registered listeners.

Method Detail

readNextPcapEntry

boolean readNextPcapEntry(T processor)

Read the next Pcap entry from the respective input stream. Implementations of this method must ensure that the passed processor parameter is called after all registered PcapProcessors had a chance to handle the Pcap-entry, i.e. after the decoding chain has been traversed. This constraint ensures that the users pcap processor may access subsequently decoded data. The methods signature is still subject to change, i.e. it is planned that the boolean return value will be changed to an integer value indicating a kind of error code.

Parameters:

processor - A Pcap-Entry processor capable of handling the read PcapActivity.

Returns:

true, iff the entry has been read and parsed successfully, false otherwise (e.g. end of stream).

getCurrentPcapActivity

PcapActivity getCurrentPcapActivity()

A convenience method that provides a reference to the currently processed PcapActivity, i.e. it returns the latest successfully decoded Pcap entry.

Returns:

the latest successfully decoded PcapActivity

addPcapProcessor

void addPcapProcessor(T processor)

Adds a custom listener or processor to the set of already registered listeners. This processor will receive a notification of all decoded Pcap entries after the previously registered processors have been notified.

Parameters:

processor - a custom listener to decoded pcap entries and related events

removePcapProcessor

void removePcapProcessor(T processor)

Removes a custom listener or processor from the set of already registered listeners. This processor will no longer receive a notification of decoded Pcap entries.

Parameters:

processor - a registered listener

close

void close()
    throws IOException

Closes the underlying input streams (if not closed already) and releases any system resources associated with it. If the streams were already closed then invoking this method has no effect.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - if an I/O error occurs