javax.media.rtp.event
Class ByeEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--javax.media.MediaEvent
              |
              +--javax.media.rtp.event.RTPEvent
                    |
                    +--javax.media.rtp.event.ReceiveStreamEvent
                          |
                          +--javax.media.rtp.event.TimeoutEvent
                                |
                                +--javax.media.rtp.event.ByeEvent

public class ByeEvent

extends TimeoutEvent

Informs the RTP listener that an RTCP 'BYE' indication has been received. If the packet was received from a passive receiver, the recvStream argument will be null since no ReceiveStream would have been created; the 'participant' argument indicates the party leaving the session.In this case the given Participant is no longer valid after this method returns (i.e. the RTPSM removes it from its participant list and drops its reference; further method calls to it will fail).

If the SSRC sending the BYE was sending RTP data, the ReceiveStream representing that data stream will be passed in as the 'recvStream' argument; in this case there is an implicit removePlayer performed on the recvStream and it becomes invalid as well. In this case the participant may or may not be removed from the session and invalidated; if the participant was sending multiple data streams it is possible to send a BYE for one of the streams but not for the participant as a whole. The 'participantBye' parameter indicates whether the participant is leaving the session; this is always true for passive receivers (see above paragraph).

See Also:

Serialized Form

Fields inherited from class java.util.EventObject

source

Constructor Summary

ByeEvent(SessionManager from, Participant participant, ReceiveStream recvStream, java.lang.String reason, boolean participantBye)

Method Summary

java.lang.String

getReason() A string sent by the terminating party, explaining why it is leaving the session

Methods inherited from class javax.media.rtp.event.TimeoutEvent

participantLeaving

Methods inherited from class javax.media.rtp.event.ReceiveStreamEvent

getParticipant, getReceiveStream

Methods inherited from class javax.media.rtp.event.RTPEvent

getSessionManager, getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ByeEvent

public ByeEvent(SessionManager from,
                Participant participant,
                ReceiveStream recvStream,
                java.lang.String reason,
                boolean participantBye)

Method Detail

getReason

public java.lang.String getReason()

A string sent by the terminating party, explaining why it is leaving the session