io.pkts.streams

Interface Stream<T extends Packet>

All Known Subinterfaces:

RtpStream, SipStream

All Known Implementing Classes:

BasicSipStream, DefaultRtpStream

public interface Stream<T extends Packet>

A Stream represents a set of Packets that belong together. E.g., in SIP, messages that goes within the same dialog will be grouped into a single stream.

Author:

jonas@jonasborjesson.com

Method Summary

Modifier and Type	Method and Description
long	getDuration() Get the duration in microseconds of the stream.
List<T>	getPackets() Get all Packets that belongs to this stream.
StreamId	getStreamIdentifier() Get the unique StreamId for this particular Stream.
long	getTimeOfFirstPacket() Get the arrival time of the very first packet in this stream.
long	getTimeOfLastPacket() Get the arrival time of the last packet in this stream.
void	write(OutputStream out) Write this Stream to the specified OutputStream.

Method Detail

getPackets

List<T> getPackets()

Get all Packets that belongs to this stream.

Returns:

getDuration

long getDuration()

Get the duration in microseconds of the stream. Note, see comment on Packet.getArrivalTime() regarding the microsecond precision. Depending on the underlying protocol this can be as simple as the time between the first to the last packet, which is what the RtpStream does. Or, it can be more complicated as with a SipStream that checks the duration of the dialog (if one was established).

Returns:

the duration (in milliseconds) of this Stream. If the duration cannot be calulated for whatever reason (no packets at all? Only one packet?), then -1 (negative one) will be returned.

getTimeOfFirstPacket

long getTimeOfFirstPacket()

Get the arrival time of the very first packet in this stream. Note, see comment on Packet.getArrivalTime() regarding the microsecond precision.

Returns:

the arrival time of the first packet (in microseconds), -1 (negative one) in case this Stream doesn't contain any packets.

getTimeOfLastPacket

long getTimeOfLastPacket()

Get the arrival time of the last packet in this stream. Note, see comment on Packet.getArrivalTime() regarding the microsecond precision.

Returns:

the arrival time of the last packet (in microseconds), -1 (negative one) in case this Stream doesn't contain any packets.

getStreamIdentifier

StreamId getStreamIdentifier()

Get the unique StreamId for this particular Stream.

Returns:

write

void write(OutputStream out)
    throws IOException

Write this Stream to the specified OutputStream. Also see Pcap.createOutputStream(OutputStream).

Parameters:

out - the OutputStream, which typically is a PcapOutputStream.

Throws:

IOException