Package org.red5.server.net.rtmp.event

Class Ping

java.lang.Object
org.red5.server.net.rtmp.event.BaseEvent
org.red5.server.net.rtmp.event.Ping
All Implemented Interfaces:
Externalizable, Serializable, IEvent, IRTMPEvent, Constants
Direct Known Subclasses:
SetBuffer, SWFResponse
public class Ping extends BaseEvent
Ping event, actually combination of different events. This is also known as a user control message.
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • STREAM_BEGIN

      public static final short STREAM_BEGIN
      Stream begin / clear event
      See Also:

    • STREAM_PLAYBUFFER_CLEAR

      public static final short STREAM_PLAYBUFFER_CLEAR
      Stream EOF, playback of requested stream is completed.
      See Also:

    • STREAM_DRY

      public static final short STREAM_DRY
      Stream is empty
      See Also:

    • CLIENT_BUFFER

      public static final short CLIENT_BUFFER
      Client buffer. Sent by client to indicate its buffer time in milliseconds.
      See Also:

    • RECORDED_STREAM

      public static final short RECORDED_STREAM
      Recorded stream. Sent by server to indicate a recorded stream.
      See Also:

    • UNKNOWN_5

      public static final short UNKNOWN_5
      One more unknown event
      See Also:

    • PING_CLIENT

      public static final short PING_CLIENT
      Client ping event. Sent by server to test if client is reachable.
      See Also:

    • PONG_SERVER

      public static final short PONG_SERVER
      Server response event. A clients ping response.
      See Also:

    • UNKNOWN_8

      public static final short UNKNOWN_8
      One more unknown event
      See Also:

    • PING_SWF_VERIFY

      public static final short PING_SWF_VERIFY
      SWF verification ping 0x001a
      See Also:

    • PONG_SWF_VERIFY

      public static final short PONG_SWF_VERIFY
      SWF verification pong 0x001b
      See Also:

    • BUFFER_EMPTY

      public static final short BUFFER_EMPTY
      Buffer empty.
      See Also:

    • BUFFER_FULL

      public static final short BUFFER_FULL
      Buffer full.
      See Also:

    • UNDEFINED

      public static final int UNDEFINED
      Event type is undefined
      See Also:

    • eventType

      protected short eventType
      The sub-type

    • value2

      private Number value2
      Represents the stream id in all cases except PING_CLIENT and PONG_SERVER where it represents the local server timestamp.

    • value3

      private int value3

    • value4

      private int value4

    • debug

      private String debug
      Debug string

  • Constructor Details

    • Ping

      public Ping()
      Constructs a new Ping.

    • Ping

      public Ping(short eventType)

    • Ping

      public Ping(short eventType, int value2)

    • Ping

      public Ping(short eventType, Number value2)

    • Ping

      public Ping(short eventType, int value2, int value3)

    • Ping

      public Ping(short eventType, Number value2, int value3)

    • Ping

      public Ping(short eventType, int value2, int value3, int value4)

    • Ping

      public Ping(short eventType, Number value2, int value3, int value4)

    • Ping

      public Ping(Ping in)

  • Method Details

    • getDataType

      public byte getDataType()
      Getter for data type
      Specified by:
      getDataType in interface IRTMPEvent
      Specified by:
      getDataType in class BaseEvent
      Returns:
      Data type

    • getEventType

      public short getEventType()
      Returns the events sub-type
      Returns:
      the event type

    • setEventType

      public void setEventType(short eventType)
      Sets the events sub-type
      Parameters:
      eventType - event type

    • getValue2

      public Number getValue2()
      Getter for property 'value2'.
      Returns:
      Value for property 'value2'.

    • setValue2

      public void setValue2(Number value2)
      Setter for property 'value2'.
      Parameters:
      value2 - Value to set for property 'value2'.

    • getValue3

      public int getValue3()
      Getter for property 'value3'.
      Returns:
      Value for property 'value3'.

    • setValue3

      public void setValue3(int value3)
      Setter for property 'value3'.
      Parameters:
      value3 - Value to set for property 'value3'.

    • getValue4

      public int getValue4()
      Getter for property 'value4'.
      Returns:
      Value for property 'value4'.

    • setValue4

      public void setValue4(int value4)
      Setter for property 'value4'.
      Parameters:
      value4 - Value to set for property 'value4'.

    • getDebug

      public String getDebug()
      Getter for property 'debug'.
      Returns:
      Value for property 'debug'.

    • setDebug

      public void setDebug(String debug)
      Setter for property 'debug'.
      Parameters:
      debug - Value to set for property 'debug'.

    • doRelease

      protected void doRelease()

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • releaseInternal

      protected void releaseInternal()
      Release event
      Specified by:
      releaseInternal in class BaseEvent

    • readExternal

      public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
      Specified by:
      readExternal in interface Externalizable
      Overrides:
      readExternal in class BaseEvent
      Throws:
      IOException
      ClassNotFoundException

    • writeExternal

      public void writeExternal(ObjectOutput out) throws IOException
      Specified by:
      writeExternal in interface Externalizable
      Overrides:
      writeExternal in class BaseEvent
      Throws:
      IOException