io.pkts.streams

Interface StreamListener<T extends Packet>

public interface StreamListener<T extends Packet>

Whenever a new Packet that belongs to a particular Stream has been detected by the StreamHandler, it will call its registered StreamListeners.

Author:

jonas@jonasborjesson.com

Method Summary

Modifier and Type	Method and Description
void	endStream(Stream<T> stream) Called when the Stream has ended.
void	packetReceived(Stream<T> stream, T packet) Called when a new Packet has been received.
void	startStream(Stream<T> stream, T packet) Called when a new Stream is detected.

Method Detail

startStream

void startStream(Stream<T> stream,
                 T packet)

Called when a new Stream is detected. Note that the Packet passed in to this method will NOT appear in packetReceived(Stream, Packet).

Parameters:

stream - the new Stream.

packet - the Packet that created the Stream.

packetReceived

void packetReceived(Stream<T> stream,
                    T packet)

Called when a new Packet has been received.

Parameters:

stream - the Stream to which the new Packet is associated with.

packet - the new Packet.

endStream

void endStream(Stream<T> stream)

Called when the Stream has ended. There are many reasons why a Stream ends and it depends on the type of Stream. For some types of a Streams, there is no "natural" end so occasionally Streams will be determined dead after some kind of timeout. For other protocols, such as SIP, the Stream will end when the dialog dies (if there is a dialog established in the first place). Note that unlike startStream(Stream, Packet) the event that kills the Stream may not actually be a Packet but may just as well be timer based and as such, there is no Packet supplied along with the endStream(Stream) method. Note, when this method is called, it is guaranteed that there will be no more Packets for this Stream so it is safe to e.g. write this Stream to file e.g. by using the PcapOutputStream.

Parameters:

stream - the Stream that just ended.