RTMP (Red5 :: Common server classes 1.0.9-RELEASE API)

java.lang.Object
- org.red5.server.net.rtmp.codec.RTMP

```
public class RTMP
extends Object
```
RTMP is the RTMP protocol state representation.

Field Summary

Fields
Modifier and Type	Field and Description
`static byte`	`STATE_CONNECT` Connect state
`static byte`	`STATE_CONNECTED` Connected
`static byte`	`STATE_DISCONNECTED` Disconnected
`static byte`	`STATE_DISCONNECTING` In the processing of disconnecting
`static byte`	`STATE_EDGE_CONNECT_ORIGIN_SENT` Sent the connect message to origin.
`static byte`	`STATE_EDGE_DISCONNECTING` Edge is disconnecting, waiting Origin close connection.
`static byte`	`STATE_ERROR` Error
`static byte`	`STATE_HANDSHAKE` Handshake state.
`static byte`	`STATE_ORIGIN_CONNECT_FORWARDED` Forwarded client's connect call to origin.
`static String[]`	`states`

Constructor Summary

Constructors
Constructor and Description

RTMP()
Creates RTMP object; essentially for storing session information.

Constructors
Constructor and Description
`RTMP()` Creates RTMP object; essentially for storing session information.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IConnection.Encoding`	`getEncoding()` Getter for encoding version.
`int`	`getLastFullTimestampWritten(int channelId)`
`Header`	`getLastReadHeader(int channelId)` Return last read header for channel.
`Packet`	`getLastReadPacket(int channelId)` Return last read packet for channel.
`Header`	`getLastReadPacketHeader(int channelId)` Returns the last "read" packet header for the given channel.
`Header`	`getLastWriteHeader(int channelId)` Return last written header for channel.
`Packet`	`getLastWritePacket(int channelId)` Return packet that has been written last.
`int`	`getReadChunkSize()` Getter for write chunk size.
`byte`	`getState()` Return current state.
`int`	`getWriteChunkSize()` Getter for write chunk size.
`boolean`	`isEncrypted()`
`void`	`setEncoding(IConnection.Encoding encoding)` Setter for encoding version.
`void`	`setEncrypted(boolean encrypted)`
`void`	`setLastFullTimestampWritten(int channelId, int timer)`
`void`	`setLastReadHeader(int channelId, Header header)` Setter for last read header.
`void`	`setLastReadPacket(int channelId, Packet packet)` Setter for last read packet.
`void`	`setLastReadPacketHeader(int channelId, Header header)` Sets the last "read" packet header for the given channel.
`void`	`setLastWriteHeader(int channelId, Header header)` Setter for last written header.
`void`	`setLastWritePacket(int channelId, Packet packet)` Setter for last written packet.
`void`	`setReadChunkSize(int readChunkSize)` Setter for read chunk size.
`void`	`setState(byte state)` Setter for state.
`void`	`setWriteChunkSize(int writeChunkSize)` Setter for write chunk size.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - states
```
public static final String[] states
```
  - STATE_CONNECT
```
public static final byte STATE_CONNECT
```
    Connect state
    
    See Also:
    
    Constant Field Values
  - STATE_HANDSHAKE
```
public static final byte STATE_HANDSHAKE
```
    Handshake state. Server sends handshake request to client right after connection established.
    
    See Also:
    
    Constant Field Values
  - STATE_CONNECTED
```
public static final byte STATE_CONNECTED
```
    Connected
    
    See Also:
    
    Constant Field Values
  - STATE_ERROR
```
public static final byte STATE_ERROR
```
    Error
    
    See Also:
    
    Constant Field Values
  - STATE_DISCONNECTING
```
public static final byte STATE_DISCONNECTING
```
    In the processing of disconnecting
    
    See Also:
    
    Constant Field Values
  - STATE_DISCONNECTED
```
public static final byte STATE_DISCONNECTED
```
    Disconnected
    
    See Also:
    
    Constant Field Values
  - STATE_EDGE_CONNECT_ORIGIN_SENT
```
public static final byte STATE_EDGE_CONNECT_ORIGIN_SENT
```
    Sent the connect message to origin.
    
    See Also:
    
    Constant Field Values
  - STATE_ORIGIN_CONNECT_FORWARDED
```
public static final byte STATE_ORIGIN_CONNECT_FORWARDED
```
    Forwarded client's connect call to origin.
    
    See Also:
    
    Constant Field Values
  - STATE_EDGE_DISCONNECTING
```
public static final byte STATE_EDGE_DISCONNECTING
```
    Edge is disconnecting, waiting Origin close connection.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RTMP
```
public RTMP()
```
    Creates RTMP object; essentially for storing session information.
- Method Detail
  - isEncrypted
```
public boolean isEncrypted()
```
    Returns:
    
    the encrypted
  - setEncrypted
```
public void setEncrypted(boolean encrypted)
```
    Parameters:
    
    encrypted - the encrypted to set
  - getState
```
public byte getState()
```
    Return current state.
    
    Returns:
    
    State
  - setState
```
public void setState(byte state)
```
    Setter for state.
    
    Parameters:
    
    state - New state
  - setLastReadHeader
```
public void setLastReadHeader(int channelId,
                              Header header)
```
    Setter for last read header.
    
    Parameters:
    
    channelId - Channel id
    
    header - Header
  - getLastReadHeader
```
public Header getLastReadHeader(int channelId)
```
    Return last read header for channel.
    
    Parameters:
    
    channelId - Channel id
    
    Returns:
    
    Last read header
  - setLastWriteHeader
```
public void setLastWriteHeader(int channelId,
                               Header header)
```
    Setter for last written header.
    
    Parameters:
    
    channelId - Channel id
    
    header - Header
  - getLastWriteHeader
```
public Header getLastWriteHeader(int channelId)
```
    Return last written header for channel.
    
    Parameters:
    
    channelId - Channel id
    
    Returns:
    
    Last written header
  - setLastReadPacket
```
public void setLastReadPacket(int channelId,
                              Packet packet)
```
    Setter for last read packet.
    
    Parameters:
    
    channelId - Channel id
    
    packet - Packet
  - getLastReadPacket
```
public Packet getLastReadPacket(int channelId)
```
    Return last read packet for channel.
    
    Parameters:
    
    channelId - Channel id
    
    Returns:
    
    Last read packet for that channel
  - setLastWritePacket
```
public void setLastWritePacket(int channelId,
                               Packet packet)
```
    Setter for last written packet.
    
    Parameters:
    
    channelId - Channel id
    
    packet - Last written packet
  - getLastWritePacket
```
public Packet getLastWritePacket(int channelId)
```
    Return packet that has been written last.
    
    Parameters:
    
    channelId - Channel id
    
    Returns:
    
    Packet that has been written last
  - getReadChunkSize
```
public int getReadChunkSize()
```
    Getter for write chunk size. Data is being read chunk-by-chunk.
    
    Returns:
    
    Read chunk size
  - setReadChunkSize
```
public void setReadChunkSize(int readChunkSize)
```
    Setter for read chunk size. Data is being read chunk-by-chunk.
    
    Parameters:
    
    readChunkSize - Value to set for property 'readChunkSize'.
  - getWriteChunkSize
```
public int getWriteChunkSize()
```
    Getter for write chunk size. Data is being written chunk-by-chunk.
    
    Returns:
    
    Write chunk size
  - setWriteChunkSize
```
public void setWriteChunkSize(int writeChunkSize)
```
    Setter for write chunk size.
    
    Parameters:
    
    writeChunkSize - Write chunk size
  - getEncoding
```
public IConnection.Encoding getEncoding()
```
    Getter for encoding version.
    
    Returns:
    
    Encoding version
  - setEncoding
```
public void setEncoding(IConnection.Encoding encoding)
```
    Setter for encoding version.
    
    Parameters:
    
    encoding - Encoding version
  - setLastFullTimestampWritten
```
public void setLastFullTimestampWritten(int channelId,
                                        int timer)
```
  - getLastFullTimestampWritten
```
public int getLastFullTimestampWritten(int channelId)
```
  - setLastReadPacketHeader
```
public void setLastReadPacketHeader(int channelId,
                                    Header header)
```
    Sets the last "read" packet header for the given channel.
    
    Parameters:
    
    channelId - channel id
    
    header - header
  - getLastReadPacketHeader
```
public Header getLastReadPacketHeader(int channelId)
```
    Returns the last "read" packet header for the given channel.
    
    Parameters:
    
    channelId - channel id
    
    Returns:
    
    Header
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class RTMP

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

states

STATE_CONNECT

STATE_HANDSHAKE

STATE_CONNECTED

STATE_ERROR

STATE_DISCONNECTING

STATE_DISCONNECTED

STATE_EDGE_CONNECT_ORIGIN_SENT

STATE_ORIGIN_CONNECT_FORWARDED

STATE_EDGE_DISCONNECTING

Constructor Detail

RTMP

Method Detail

isEncrypted

setEncrypted

getState

setState

setLastReadHeader

getLastReadHeader

setLastWriteHeader

getLastWriteHeader

setLastReadPacket

getLastReadPacket

setLastWritePacket

getLastWritePacket

getReadChunkSize

setReadChunkSize

getWriteChunkSize

setWriteChunkSize

getEncoding

setEncoding

setLastFullTimestampWritten

getLastFullTimestampWritten

setLastReadPacketHeader

getLastReadPacketHeader

toString