org.mobicents.media.server.impl.rtcp

Class RtcpHandler

java.lang.Object

org.mobicents.media.server.impl.rtcp.RtcpHandler

All Implemented Interfaces:

Comparable<PacketHandler>, PacketHandler

public class RtcpHandler
extends Object
implements PacketHandler

Author:

Henrique Rosa ([email protected])

Constructor Summary

Constructors

Constructor and Description
RtcpHandler(Scheduler scheduler, RtpStatistics statistics)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canHandle(byte[] packet)
boolean	canHandle(byte[] packet, int dataLength, int offset)
int	compareTo(PacketHandler o)
void	disableSRTCP() Disables secure layer on the channel, meaning all traffic is treated as plain RTCP.
void	enableSRTCP(DtlsHandler dtlsHandler) Secures the channel, meaning all traffic is SRTCP.
long	getNextScheduledReport() Gets the time interval until the next report is sent.
int	getPipelinePriority()
byte[]	handle(byte[] packet, InetSocketAddress localPeer, InetSocketAddress remotePeer)
byte[]	handle(byte[] packet, int dataLength, int offset, InetSocketAddress localPeer, InetSocketAddress remotePeer)
boolean	isInitial() Gets whether the handler is in initial stage. The handler is in initial stage until it has sent at least one RTCP packet during the current RTP session.
boolean	isJoined() Gets whether the handler is currently joined to an RTP Session.
void	joinRtpSession() Upon joining the session, the participant initializes tp to 0, tc to 0, senders to 0, pmembers to 1, members to 1, we_sent to false, rtcp_bw to the specified fraction of the session bandwidth, initial to true, and avg_rtcp_size to the probable size of the first RTCP packet that the application will later construct.
void	leaveRtpSession()
void	reset()
void	setChannel(DatagramChannel channel)
void	setPipelinePriority(int pipelinePriority)

Methods inherited from class java.lang.Object

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

Constructor Detail

RtcpHandler

public RtcpHandler(Scheduler scheduler,
           RtpStatistics statistics)

Method Detail

getPipelinePriority

public int getPipelinePriority()

Specified by:

getPipelinePriority in interface PacketHandler

setPipelinePriority

public void setPipelinePriority(int pipelinePriority)

setChannel

public void setChannel(DatagramChannel channel)

isInitial

public boolean isInitial()

Gets whether the handler is in initial stage.
The handler is in initial stage until it has sent at least one RTCP packet during the current RTP session.

Returns:

true if not rtcp packet has been sent, false otherwise.

isJoined

public boolean isJoined()

Gets whether the handler is currently joined to an RTP Session.

Returns:

Return true if joined. Otherwise, returns false.

joinRtpSession

public void joinRtpSession()

Upon joining the session, the participant initializes tp to 0, tc to 0, senders to 0, pmembers to 1, members to 1, we_sent to false, rtcp_bw to the specified fraction of the session bandwidth, initial to true, and avg_rtcp_size to the probable size of the first RTCP packet that the application will later construct. The calculated interval T is then computed, and the first packet is scheduled for time tn = T. This means that a transmission timer is set which expires at time T. Note that an application MAY use any desired approach for implementing this timer. The participant adds its own SSRC to the member table.

leaveRtpSession

public void leaveRtpSession()

getNextScheduledReport

public long getNextScheduledReport()

Gets the time interval until the next report is sent.

Returns:

Returns the time interval in milliseconds until the report is sent. Returns -1 if no report is currently scheduled.

enableSRTCP

public void enableSRTCP(DtlsHandler dtlsHandler)

Secures the channel, meaning all traffic is SRTCP. SRTCP handlers will only be available to process traffic after a DTLS handshake is completed.

Parameters:

remotePeerFingerprint - The DTLS fingerprint of the remote peer. Use to setup DTLS keying material.

disableSRTCP

public void disableSRTCP()

Disables secure layer on the channel, meaning all traffic is treated as plain RTCP.

canHandle

public boolean canHandle(byte[] packet)

Specified by:

canHandle in interface PacketHandler

canHandle

public boolean canHandle(byte[] packet,
                int dataLength,
                int offset)

Specified by:

canHandle in interface PacketHandler

handle

public byte[] handle(byte[] packet,
            InetSocketAddress localPeer,
            InetSocketAddress remotePeer)
              throws PacketHandlerException

Specified by:

handle in interface PacketHandler

Throws:

PacketHandlerException

handle

public byte[] handle(byte[] packet,
            int dataLength,
            int offset,
            InetSocketAddress localPeer,
            InetSocketAddress remotePeer)
              throws PacketHandlerException

Specified by:

handle in interface PacketHandler

Throws:

PacketHandlerException

reset

public void reset()

compareTo

public int compareTo(PacketHandler o)

Specified by:

compareTo in interface Comparable<PacketHandler>