io.pkts.streams

Interface StreamHandler

All Superinterfaces:

PacketHandler

All Known Implementing Classes:

DefaultStreamHandler

public interface StreamHandler
extends PacketHandler

The StreamHandler is a higher-level PacketHandler that consumes streams and calls its registered StreamListeners.

Author:

jonas@jonasborjesson.com

Method Summary

Modifier and Type	Method and Description
void	addStreamListener(StreamListener<? extends Packet> listener) Add a StreamListener to this StreamHandler.
SipStatistics	getSipStatistics() If there is a registered StreamListener for SipPackets then this StreamHandler will start processing SIP messages for which you can get all the statistics for through this method.
Map<StreamId,? extends Stream>	getStreams() Through the StreamListener.startStream(Stream, Packet) and StreamListener.endStream(Stream) you will get notified when a stream starts and when it ends.
void	setFragmentListener(FragmentListener listener) Set the FragmentListener.

Methods inherited from interface io.pkts.PacketHandler

nextPacket

Method Detail

addStreamListener

void addStreamListener(StreamListener<? extends Packet> listener)
                throws IllegalArgumentException

Add a StreamListener to this StreamHandler.

Parameters:

listener -

Throws:

IllegalArgumentException - in case the StreamListener is not propertly parameterized.

setFragmentListener

void setFragmentListener(FragmentListener listener)

Set the FragmentListener. Note, only one of these listeners is allowed so if you set a second one the previous listener will be thrown away.

Parameters:

listener - the listener or null if you want to remove a previously set listener.

getSipStatistics

SipStatistics getSipStatistics()

If there is a registered StreamListener for SipPackets then this StreamHandler will start processing SIP messages for which you can get all the statistics for through this method.

Returns:

a SipStatistics object. Note, if this StreamHandler has not been configured to handle sip traffic then all the stats will be zero.

getStreams

Map<StreamId,? extends Stream> getStreams()

Through the StreamListener.startStream(Stream, Packet) and StreamListener.endStream(Stream) you will get notified when a stream starts and when it ends. However, at the end of a run there may be many streams that are still "running". E.g., in the case of SIP, there are probably many un-terminated INVITE dialogs, i.e. calls that are still in the process of being established or still in call. These streams have not ended yet so at the end of the run you can use this method to get all the streams that are left.

Returns: