io.pkts.packet.rtp.impl

Class RtpPacketImpl

java.lang.Object

io.pkts.packet.impl.AbstractPacket

io.pkts.packet.rtp.impl.RtpPacketImpl

All Implemented Interfaces:

ApplicationPacket, Packet, RtpPacket, Cloneable

public final class RtpPacketImpl
extends AbstractPacket
implements RtpPacket

Author:

jonas@jonasborjesson.com

Constructor Summary

Constructors

Constructor and Description
RtpPacketImpl(TransportPacket parent, Buffer headers, Buffer payload)

Method Summary

Modifier and Type	Method and Description
RtpPacket	clone()
byte[]	dumpPacket() Dump the entire RtpPacket as a raw byte-array.
long	getArrivalTime() The arrival time of this packet in microseconds relative to epoch (midnight UTC of January 1, 1970).
int	getContributingSource()
Packet	getNextPacket() Get the next frame, or null if there is none.
TransportPacket	getParentPacket() Almost all packets have a parent, which is the encapsulating protocol.
int	getPayloadType()
int	getSeqNumber()
long	getSyncronizationSource()
long	getTimestamp()
int	getVersion()
boolean	hasExtensions()
boolean	hasMarker()
boolean	hasPadding()
String	toString()
void	verify() Calling this method will force the packet to completely parse its data and check so that all the information conforms to whatever rules this packet needs to follow.
void	write(OutputStream out, Buffer payload) Writes this packet to the OutputStream with the supplied payload.

Methods inherited from class io.pkts.packet.impl.AbstractPacket

checkParent, getName, getPacket, getPayload, getProtocol, hasProtocol, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.pkts.packet.Packet

getName, getPacket, getPayload, getProtocol, hasProtocol, write

Constructor Detail

RtpPacketImpl

public RtpPacketImpl(TransportPacket parent,
                     Buffer headers,
                     Buffer payload)

Method Detail

getVersion

public int getVersion()

Specified by:

getVersion in interface RtpPacket

hasPadding

public boolean hasPadding()
                   throws IOException

Specified by:

hasPadding in interface RtpPacket

Throws:

IOException

hasExtensions

public boolean hasExtensions()
                      throws IOException

Specified by:

hasExtensions in interface RtpPacket

Throws:

IOException

hasMarker

public boolean hasMarker()
                  throws IOException

Specified by:

hasMarker in interface RtpPacket

Throws:

IOException

getPayloadType

public int getPayloadType()
                   throws IOException

Specified by:

getPayloadType in interface RtpPacket

Throws:

IOException

getSeqNumber

public int getSeqNumber()
                 throws IOException

Specified by:

getSeqNumber in interface RtpPacket

Throws:

IOException

getTimestamp

public long getTimestamp()
                  throws IOException

Specified by:

getTimestamp in interface RtpPacket

Throws:

IOException

getSyncronizationSource

public long getSyncronizationSource()
                             throws IOException

Specified by:

getSyncronizationSource in interface RtpPacket

Throws:

IOException

getContributingSource

public int getContributingSource()
                          throws IOException

Specified by:

getContributingSource in interface RtpPacket

Throws:

IOException

verify

public void verify()

Calling this method will force the packet to completely parse its data and check so that all the information conforms to whatever rules this packet needs to follow. E.g., if this happens to be a SIP packet, then it will check if it has the mandatory headers etc. Some simpler packets, such as the IPPacket, hardly does anything in this method but more complex protocols such as SIP (once again), HTTP etc can spend quite some time verifying everything, which is why you don't want to do it unless you really have to. In general, yajpcap has the philosophy of "assume that everything is ok until things blow up and then deal with it"

Specified by:

verify in interface Packet

Overrides:

verify in class AbstractPacket

getArrivalTime

public long getArrivalTime()

The arrival time of this packet in microseconds relative to epoch (midnight UTC of January 1, 1970). Note, since this returns with microseconds precision (which may or may not be relevant depending on the hardware on which the packet was captured on) and you wish to format this arrival time into a more human readable format you could use the SimpleDateFormat but it can only handle milliseconds precision (you will have to write your own date formatter if you want microseconds). Here is a snippet illustrating how to turn the arrival time of the packet into a human readable date

 Packet p = ...;
 SimpleDateFormat formatter = new SimpleDateFormat("yyyy.MM.dd HH:mm:ss.SSS");
 Date date = new Date(p.getArrivalTime() / 1000);
 System.out.println("Arrival time: " + formatter.format(date));
 

Note how an integer devision is performed on the arrival time to "cut off" the microseconds from the time stamp

Specified by:

getArrivalTime in interface Packet

Returns:

the arrival time of the packet in microseconds since the start of the epoch

toString

public String toString()

Overrides:

toString in class Object

dumpPacket

public byte[] dumpPacket()

Description copied from interface: RtpPacket

Dump the entire RtpPacket as a raw byte-array.

Specified by:

dumpPacket in interface RtpPacket

Returns:

write

public void write(OutputStream out,
                  Buffer payload)
           throws IOException

Description copied from interface: Packet

Writes this packet to the OutputStream with the supplied payload. You can use this method to e.g. write a raw UDPPacket to the stream with this payload. Note, if the UDPPacket already had a payload it will be ignored so use this method with care.

Specified by:

write in interface Packet

Throws:

IOException

clone

public RtpPacket clone()

Specified by:

clone in interface Packet

Specified by:

clone in class AbstractPacket

getNextPacket

public Packet getNextPacket()
                     throws IOException

Description copied from interface: Packet

Get the next frame, or null if there is none. Note, if there isn't another frame but there is still raw data within this frame, it only means that we didn't recognize the payload.

Specified by:

getNextPacket in interface Packet

Returns:

Throws:

IOException

getParentPacket

public TransportPacket getParentPacket()

Description copied from interface: Packet

Almost all packets have a parent, which is the encapsulating protocol. E.g., the parent of a SipPacket is typically a TransportPacket such as UDPPacket or a TCPPacket. The parent of a TransportPacket is usually a IPPacket and so on.

Specified by:

getParentPacket in interface Packet

Specified by:

getParentPacket in interface RtpPacket

Overrides:

getParentPacket in class AbstractPacket

Returns: