org.jlibrtp.protocols.rtp

Class RTPURLConnection

java.lang.Object

java.net.URLConnection

org.jlibrtp.protocols.rtp.RTPURLConnection

All Implemented Interfaces:

RTCPAppIntf, RTPAppIntf

public class RTPURLConnection
extends java.net.URLConnection
implements RTPAppIntf, RTCPAppIntf

Title: RTPURLConnection

Description: Handler to protocol rtp://

Copyright: Copyright (c) 2007-2008

Company: VoiceInteraction

Version:

1.0

Author:

Renato Cassaca

Field Summary

Fields inherited from class java.net.URLConnection

allowUserInteraction, connected, doInput, doOutput, ifModifiedSince, url, useCaches

Constructor Summary

Constructors

Constructor and Description
RTPURLConnection(java.net.URL url) Object constructor

Method Summary

Modifier and Type	Method and Description
void	APPPktReceived(Participant part, int subtype, byte[] name, byte[] data) This function is called whenever an Application (APP) packet is received.
void	BYEPktReceived(Participant[] relevantParticipants, java.lang.String reason) This function is called whenever a Bye (BYE) packet is received.
void	connect() Opens a communications link to the resource referenced by this URL, if such a connection has not already been established.
int	frameSize(int payloadType) The callback method through which the application can specify the number of packets that make up a frame for a given payload type.
java.io.InputStream	getInputStream()
java.io.OutputStream	getOutputStream() Returns an output stream that writes to this connection.
void	receiveData(DataFrame frame, Participant p) TODO PipeOutputStream.write blocks until data is written! work around it
void	RRPktReceived(long reporterSsrc, long[] reporteeSsrc, int[] lossFraction, int[] cumulPacketsLost, long[] extHighSeq, long[] interArrivalJitter, long[] lastSRTimeStamp, long[] delayLastSR) This function is called whenever a Receiver Report (SR) packet is received and returns unmodified values.
void	SDESPktReceived(Participant[] relevantParticipants) This function is called whenever a Source Description (SDES) packet is received.
void	SRPktReceived(long ssrc, long ntpHighOrder, long ntpLowOrder, long rtpTimestamp, long packetCount, long octetCount, long[] reporteeSsrc, int[] lossFraction, int[] cumulPacketsLost, long[] extHighSeq, long[] interArrivalJitter, long[] lastSRTimeStamp, long[] delayLastSR) This function is called whenever a Sender Report (SR) packet is received and returns unmodified values.
void	userEvent(int type, Participant[] participant) The callback method through which the application will receive notifications about user updates, additions and byes.

Methods inherited from class java.net.URLConnection

addRequestProperty, getAllowUserInteraction, getConnectTimeout, getContent, getContent, getContentEncoding, getContentLength, getContentLengthLong, getContentType, getDate, getDefaultAllowUserInteraction, getDefaultRequestProperty, getDefaultUseCaches, getDoInput, getDoOutput, getExpiration, getFileNameMap, getHeaderField, getHeaderField, getHeaderFieldDate, getHeaderFieldInt, getHeaderFieldKey, getHeaderFieldLong, getHeaderFields, getIfModifiedSince, getLastModified, getPermission, getReadTimeout, getRequestProperties, getRequestProperty, getURL, getUseCaches, guessContentTypeFromName, guessContentTypeFromStream, setAllowUserInteraction, setConnectTimeout, setContentHandlerFactory, setDefaultAllowUserInteraction, setDefaultRequestProperty, setDefaultUseCaches, setDoInput, setDoOutput, setFileNameMap, setIfModifiedSince, setReadTimeout, setRequestProperty, setUseCaches, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

RTPURLConnection

public RTPURLConnection(java.net.URL url)
                 throws java.lang.UnsupportedOperationException,
                        java.net.URISyntaxException

Object constructor

Parameters:

url - URL

Throws:

java.lang.UnsupportedOperationException

java.net.URISyntaxException

Method Detail

connect

public void connect()
             throws java.io.IOException

Opens a communications link to the resource referenced by this URL, if such a connection has not already been established.

Specified by:

connect in class java.net.URLConnection

Throws:

java.io.IOException - if an I/O error occurs while opening the connection.

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException

Overrides:

getInputStream in class java.net.URLConnection

Throws:

java.io.IOException

getOutputStream

public java.io.OutputStream getOutputStream()
                                     throws java.io.IOException

Returns an output stream that writes to this connection.

Overrides:

getOutputStream in class java.net.URLConnection

Returns:

OutputStream

Throws:

java.io.IOException

receiveData

public void receiveData(DataFrame frame,
                        Participant p)

TODO PipeOutputStream.write blocks until data is written! work around it

Specified by:

receiveData in interface RTPAppIntf

Parameters:

frame - DataFrame

p - Participant

userEvent

public void userEvent(int type,
                      Participant[] participant)

Description copied from interface: RTPAppIntf

The callback method through which the application will receive notifications about user updates, additions and byes. Types: 1 - Bye 2 - New through RTP, check .getRtpSendSock() 3 - New through RTCP, check .getRtcpSendSock() 4 - SDES packet received, check the getCname() etc methods 5 - Matched SSRC to ip-address provided by application

Specified by:

userEvent in interface RTPAppIntf

Parameters:

type - the type of event

participant - the participants in question

frameSize

public int frameSize(int payloadType)

Description copied from interface: RTPAppIntf

The callback method through which the application can specify the number of packets that make up a frame for a given payload type. A negative value denotes frames of variable length, so jlibrtp will return whatever it has at the time. In most applications, this function can simply return 1. This should be implemented as something fast, such as an integer array with the indexes being the payload type.

Specified by:

frameSize in interface RTPAppIntf

Parameters:

payloadType - the payload type specified in the RTP packet

Returns:

the number of packets that make up a frame

SRPktReceived

public void SRPktReceived(long ssrc,
                          long ntpHighOrder,
                          long ntpLowOrder,
                          long rtpTimestamp,
                          long packetCount,
                          long octetCount,
                          long[] reporteeSsrc,
                          int[] lossFraction,
                          int[] cumulPacketsLost,
                          long[] extHighSeq,
                          long[] interArrivalJitter,
                          long[] lastSRTimeStamp,
                          long[] delayLastSR)

Description copied from interface: RTCPAppIntf

This function is called whenever a Sender Report (SR) packet is received and returns unmodified values. A sender report may optionally include Receiver Reports (RR), which are returned as arrays. Index i corresponds to the same report throughout all of the arrays.

Specified by:

SRPktReceived in interface RTCPAppIntf

Parameters:

ssrc - the (SR) SSRC of the sender

ntpHighOrder - (SR) NTP high order

ntpLowOrder - (SR) NTP low order

rtpTimestamp - (SR) RTP timestamp corresponding to the NTP timestamp

packetCount - (SR) Packets sent since start of session

octetCount - (SR) Octets sent since start of session

reporteeSsrc - (RR) SSRC of sender the receiver is reporting in

lossFraction - (RR) Loss fraction, see RFC 3550

cumulPacketsLost - (RR) Cumulative number of packets lost

extHighSeq - (RR) Extended highest sequence RTP packet received

interArrivalJitter - (RR) Interarrival jitter, see RFC 3550

lastSRTimeStamp - (RR) RTP timestamp when last SR was received

delayLastSR - (RR) Delay, in RTP, since last SR was received

RRPktReceived

public void RRPktReceived(long reporterSsrc,
                          long[] reporteeSsrc,
                          int[] lossFraction,
                          int[] cumulPacketsLost,
                          long[] extHighSeq,
                          long[] interArrivalJitter,
                          long[] lastSRTimeStamp,
                          long[] delayLastSR)

Description copied from interface: RTCPAppIntf

This function is called whenever a Receiver Report (SR) packet is received and returns unmodified values. A receiver report may optionally include report blocks, which are returned as arrays. Index i corresponds to the same report throughout all of the arrays.

Specified by:

RRPktReceived in interface RTCPAppIntf

Parameters:

reporterSsrc - SSRC of the receiver reporting

reporteeSsrc - (RR) SSRC of sender the receiver is reporting in

lossFraction - (RR) Loss fraction, see RFC 3550

cumulPacketsLost - (RR) Cumulative number of packets lost

extHighSeq - (RR) Extended highest sequence RTP packet received

interArrivalJitter - (RR) Interarrival jitter, see RFC 3550

lastSRTimeStamp - (RR) RTP timestamp when last SR was received

delayLastSR - (RR) Delay, in RTP, since last SR was received

SDESPktReceived

public void SDESPktReceived(Participant[] relevantParticipants)

Description copied from interface: RTCPAppIntf

This function is called whenever a Source Description (SDES) packet is received. It currently returns the updated participants AFTER they have been updated.

Specified by:

SDESPktReceived in interface RTCPAppIntf

Parameters:

relevantParticipants - participants mentioned in the SDES packet

BYEPktReceived

public void BYEPktReceived(Participant[] relevantParticipants,
                           java.lang.String reason)

Description copied from interface: RTCPAppIntf

This function is called whenever a Bye (BYE) packet is received. The participants will automatically be deleted from the participant database after some time, but in the mean time the application may still receive RTP packets from this source.

Specified by:

BYEPktReceived in interface RTCPAppIntf

Parameters:

relevantParticipants - participants whose SSRC was in the packet

reason - the reason provided in the packet

APPPktReceived

public void APPPktReceived(Participant part,
                           int subtype,
                           byte[] name,
                           byte[] data)

Description copied from interface: RTCPAppIntf

This function is called whenever an Application (APP) packet is received.

Specified by:

APPPktReceived in interface RTCPAppIntf

Parameters:

part - the participant associated with the SSRC

subtype - specified in the packet

name - ASCII description of packet

data - in the packet