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

java.lang.Object
- org.red5.server.AttributeStore
- - org.red5.server.BaseConnection
  - - org.red5.server.net.rtmp.RTMPConnection

All Implemented Interfaces:

IEventDispatcher, IEventHandler, IEventListener, IAttributeStore, ICastingAttributeStore, IConnection, ICoreObject, IServiceCapableConnection, IStreamCapableConnection, AttributeStoreMXBean, IReceivedMessageTaskQueueListener

Direct Known Subclasses:

RTMPMinaConnection
```
public abstract class RTMPConnection
extends BaseConnection
implements IStreamCapableConnection, IServiceCapableConnection, IReceivedMessageTaskQueueListener
```
RTMP connection. Stores information about client streams, data transfer channels, pending RPC calls, bandwidth configuration, AMF encoding type (AMF0/AMF3), connection state (is alive, last ping time and ping result) and session.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.red5.server.api.IConnection
  IConnection.Duty, IConnection.Encoding, IConnection.Type

Field Summary

Fields
Modifier and Type	Field and Description
`protected long`	`bytesReadInterval` Data read interval
`protected ThreadPoolTaskScheduler`	`deadlockGuardScheduler` Thread pool for guarding deadlocks.
`protected Semaphore`	`decoderLock`
`protected RTMPDecodeState`	`decoderState`
`protected Semaphore`	`encoderLock`
`protected ThreadPoolTaskExecutor`	`executor` Thread pool for message handling.
`protected IRTMPHandler`	`handler` RTMP events handler
`protected int`	`limitType` Bandwidth limit type / enforcement.
`static double`	`MAX_RESERVED_STREAMS`
`protected long`	`maxHandlingTimeout` Maximum time in milliseconds allowed to process received message
`protected int`	`maxInactivity` Maximum time in ms after which a client is disconnected because of inactivity.
`protected long`	`nextBytesRead` Number of bytes to read next.
`static String`	`RTMP_CONN_MANAGER`
`static byte`	`RTMP_ENCRYPTED` Marker byte for encrypted RTMP data.
`static byte`	`RTMP_ENCRYPTED_BLOWFISH` Marker byte for encrypted RTMP data using Blowfish.
`static byte`	`RTMP_ENCRYPTED_UNK` Unknown type 0x0a, seen on youtube
`static byte`	`RTMP_ENCRYPTED_XTEA` Marker byte for encrypted RTMP data XTEA.
`static Object`	`RTMP_HANDLER`
`static String`	`RTMP_HANDSHAKE`
`static byte`	`RTMP_NON_ENCRYPTED` Marker byte for standard or non-encrypted RTMP data.
`static String`	`RTMP_SESSION_ID`
`static String`	`RTMPE_CIPHER_IN` Cipher for RTMPE input
`static String`	`RTMPE_CIPHER_OUT` Cipher for RTMPE output
`protected AtomicBoolean`	`running` Keep-alive worker flag
`protected ThreadPoolTaskScheduler`	`scheduler` Scheduling service
`protected RTMP`	`state` Protocol state

Fields inherited from class org.red5.server.BaseConnection
basicScopes, client, connectionListeners, droppedMessages, duty, host, params, path, readMessages, remoteAddress, remoteAddresses, remotePort, scope, sessionId, type, writtenMessages

Fields inherited from class org.red5.server.AttributeStore
attributes

Constructor Summary

Constructors
Constructor and Description

RTMPConnection(String type)
Creates anonymous RTMP connection without scope.

Constructors
Constructor and Description
`RTMPConnection(String type)` Creates anonymous RTMP connection without scope.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addClientStream(IClientStream stream)`
`void`	`close()` Closes connection
`void`	`closeChannel(int channelId)` Closes channel.
`boolean`	`connect(IScope newScope, Object[] params)` Connect to another scope on server with given parameters
`OutputStream`	`createOutputStream(Number streamId)` Creates output stream object from stream id.
`protected String`	`createStreamName()` Generates new stream name.
`protected int`	`currentQueueSize()` Returns the current received message queue size.
`void`	`deleteStreamById(Number streamId)` Deletes the stream with the given id.
`void`	`dispatchEvent(IEvent event)` Dispatches event
`Channel`	`getChannel(int channelId)` Return channel by id.
`int`	`getChannelIdForStreamId(Number streamId)` Return channel id for given stream id.
`int`	`getChannelsConcurrencyLevel()`
`int`	`getChannelsInitalCapacity()`
`long`	`getClientBytesRead()` Get number of bytes the client reported to have received.
`ThreadPoolTaskScheduler`	`getDeadlockGuardScheduler()` Thread pool for guarding deadlocks
`Semaphore`	`getDecoderLock()`
`RTMPDecodeState`	`getDecoderState()`
`Semaphore`	`getEncoderLock()`
`IConnection.Encoding`	`getEncoding()` Return AMF protocol encoding used by this connection.
`ThreadPoolTaskExecutor`	`getExecutor()`
`IRTMPHandler`	`getHandler()`
`int`	`getId()`
`org.apache.mina.core.session.IoSession`	`getIoSession()`
`int`	`getLastPingSentAndLastPongReceivedInterval()` Difference between when the last ping was sent and when the last pong was received.
`int`	`getLastPingTime()` Return round-trip time of last ping command.
`long`	`getMaxHandlingTimeout()`
`int`	`getNextAvailableChannelId()` Getter for next available channel id.
`IPendingServiceCall`	`getPendingCall(int invokeId)` Get pending call service by id.
`int`	`getPendingCallsConcurrencyLevel()`
`int`	`getPendingCallsInitalCapacity()`
`long`	`getPendingVideoMessages(Number streamId)` Count of outgoing video messages not yet written.
`String`	`getProtocol()` Returns the protocol type for this connection.
`long`	`getReadBytes()` Total number of bytes read from the connection.
`int`	`getReservedStreamsConcurrencyLevel()`
`int`	`getReservedStreamsInitalCapacity()`
`ThreadPoolTaskScheduler`	`getScheduler()`
`RTMP`	`getState()`
`byte`	`getStateCode()`
`IClientStream`	`getStreamByChannelId(int channelId)` Return stream by given channel id.
`IClientStream`	`getStreamById(Number streamId)` Get a stream by its id.
`Number`	`getStreamIdForChannelId(int channelId)` Return stream id for given channel id.
`protected Collection<IClientStream>`	`getStreams()` Getter for client streams.
`int`	`getStreamsConcurrencyLevel()`
`int`	`getStreamsInitalCapacity()`
`Map<Number,IClientStream>`	`getStreamsMap()`
`int`	`getTimer()` Returns a usable timestamp for written packets.
`int`	`getTransactionId()` Generate next invoke id.
`protected int`	`getUsedStreamCount()` Getter for used stream count.
`long`	`getWrittenBytes()` Total number of bytes written to the connection.
`void`	`handleMessageReceived(Packet packet)` Handle the incoming message.
`void`	`invoke(IServiceCall call)` Invokes service using remoting call object.
`void`	`invoke(IServiceCall call, int channel)` Invoke service using call and channel.
`void`	`invoke(String method)` Invoke method by name.
`void`	`invoke(String method, IPendingServiceCallback callback)` Invoke method by name with callback.
`void`	`invoke(String method, Object[] params)` Invoke method with parameters.
`void`	`invoke(String method, Object[] params, IPendingServiceCallback callback)` Invoke method with parameters.
`boolean`	`isChannelUsed(int channelId)` Checks whether channel is used.
`boolean`	`isDisconnected()` Returns whether or not the connection is disconnected.
`boolean`	`isIdle()` Returns whether or not the connection has been idle for a maximum period.
`boolean`	`isValidStreamId(Number streamId)` Returns whether or not a given stream id is valid.
`protected void`	`messageDropped()` Increases number of dropped messages.
`void`	`messageReceived()` Increases number of read messages by one.
`void`	`messageSent(Packet message)` Mark message as sent.
`String`	`messageTypeToName(byte headerDataType)`
`IClientBroadcastStream`	`newBroadcastStream(Number streamId)` Create a broadcast stream.
`IPlaylistSubscriberStream`	`newPlaylistSubscriberStream(Number streamId)` Create a stream that can play a list.
`ISingleItemSubscriberStream`	`newSingleItemSubscriberStream(Number streamId)` Create a stream that can play only one item.
`void`	`notify(IServiceCall call)` Notify method.
`void`	`notify(IServiceCall call, int channel)` Notify method with channel id.
`void`	`notify(String method)` Notify method.
`void`	`notify(String method, Object[] params)` Notify method with parameters.
`protected abstract void`	`onInactive()` Inactive state event handler.
`void`	`onTaskAdded(ReceivedMessageTaskQueue queue)`
`void`	`onTaskRemoved(ReceivedMessageTaskQueue queue)`
`void`	`open()` Opens the connection.
`void`	`ping()` Start measuring the round-trip time for a packet on the connection.
`void`	`ping(Ping ping)` Handler for ping event.
`void`	`pingReceived(Ping pong)` Marks that ping back was received.
`void`	`receivedBytesRead(int bytes)` Read number of received bytes.
`void`	`registerDeferredResult(DeferredResult result)` Registers deferred result.
`void`	`registerPendingCall(int invokeId, IPendingServiceCall call)` Register pending call (remote function call that is yet to finish).
`void`	`rememberStreamBufferDuration(int streamId, int bufferDuration)`
`void`	`removeClientStream(Number streamId)`
`Number`	`reserveStreamId()` Return a reserved stream id for use.
`Number`	`reserveStreamId(Number streamId)` Return a reserved stream id for use with a preference for the one supplied.
`IPendingServiceCall`	`retrievePendingCall(int invokeId)` Retrieves and removes the pending call service by id.
`void`	`sendPendingServiceCallsCloseError()` When the connection has been closed, notify any remaining pending service calls that they have failed because the connection is broken.
`void`	`sendSharedObjectMessage(String name, int currentVersion, boolean persistent, ConcurrentLinkedQueue<ISharedObjectEvent> events)` Send a shared object message.
`void`	`setBandwidth(int mbits)` Sets the bandwidth using a mbit/s value.
`void`	`setChannelsConcurrencyLevel(int channelsConcurrencyLevel)`
`void`	`setChannelsInitalCapacity(int channelsInitalCapacity)`
`void`	`setDeadlockGuardScheduler(ThreadPoolTaskScheduler deadlockGuardScheduler)` Thread pool for guarding deadlocks
`void`	`setExecutor(ThreadPoolTaskExecutor executor)`
`void`	`setExecutorQueueSizeToDropAudioPackets(Integer executorQueueSizeToDropAudioPackets)` Specify the size of queue that will trigger audio packet dropping, disabled if it's 0
`void`	`setHandler(IRTMPHandler handler)`
`void`	`setId(int clientId)` Deprecated.
`void`	`setMaxHandlingTimeout(long maxHandlingTimeout)`
`void`	`setMaxHandshakeTimeout(int maxHandshakeTimeout)` Set maximum time to wait for valid handshake in milliseconds.
`void`	`setMaxInactivity(int maxInactivity)` Setter for maximum inactivity.
`void`	`setPendingCallsConcurrencyLevel(int pendingCallsConcurrencyLevel)`
`void`	`setPendingCallsInitalCapacity(int pendingCallsInitalCapacity)`
`void`	`setPingInterval(int pingInterval)` Setter for ping interval.
`void`	`setReservedStreamsConcurrencyLevel(int reservedStreamsConcurrencyLevel)`
`void`	`setReservedStreamsInitalCapacity(int reservedStreamsInitalCapacity)`
`void`	`setScheduler(ThreadPoolTaskScheduler scheduler)` Sets the scheduler.
`void`	`setStateCode(byte code)`
`void`	`setStreamsConcurrencyLevel(int streamsConcurrencyLevel)`
`void`	`setStreamsInitalCapacity(int streamsInitalCapacity)`
`void`	`setup(String host, String path, Map<String,Object> params)` Initialize connection.
`void`	`startWaitForHandshake()` Start waiting for a valid handshake.
`void`	`status(Status status)` Sends a status object to the connection.
`void`	`status(Status status, int channel)` Sends a status object to the connection on a given channel.
`String`	`toString()`
`void`	`unregisterDeferredResult(DeferredResult result)` Unregister deferred result
`void`	`unreserveStreamId(Number streamId)` Unreserve this id for future use.
`protected void`	`updateBytesRead()` Update number of bytes to read next value.
`abstract void`	`write(Packet out)` Write packet.
`abstract void`	`writeRaw(org.apache.mina.core.buffer.IoBuffer out)` Write raw byte buffer.
`protected void`	`writingMessage(Packet message)` Mark message as being written.

Methods inherited from class org.red5.server.BaseConnection
addListener, connect, equals, getBasicScopes, getClient, getConnectParams, getDroppedMessages, getDuty, getHost, getLock, getPath, getPendingMessages, getReadMessages, getRemoteAddress, getRemoteAddresses, getRemotePort, getScope, getSessionId, getStreamId, getType, getWrittenMessages, handleEvent, hashCode, initialize, isClosed, isConnected, isReaderIdle, isWriterIdle, notifyEvent, registerBasicScope, registerBasicScope, removeListener, setClient, setDuty, setStreamId, unregisterBasicScope

Methods inherited from class org.red5.server.AttributeStore
filterNull, from, getAttribute, getAttribute, getAttributeNames, getAttributes, getBoolAttribute, getByteAttribute, getDoubleAttribute, getIntAttribute, getListAttribute, getLongAttribute, getMapAttribute, getSetAttribute, getShortAttribute, getStringAttribute, hasAttribute, removeAttribute, removeAttributes, setAttribute, setAttributes, setAttributes, size

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

Methods inherited from interface org.red5.server.api.IConnection
addListener, connect, getBasicScopes, getClient, getConnectParams, getDroppedMessages, getDuty, getHost, getPath, getPendingMessages, getReadMessages, getRemoteAddress, getRemoteAddresses, getRemotePort, getScope, getSessionId, getStreamId, getType, getWrittenMessages, initialize, isConnected, removeListener, setClient, setStreamId

Methods inherited from interface org.red5.server.api.event.IEventHandler
handleEvent

Methods inherited from interface org.red5.server.api.event.IEventListener
notifyEvent

Methods inherited from interface org.red5.server.api.ICastingAttributeStore
getBoolAttribute, getByteAttribute, getDoubleAttribute, getIntAttribute, getListAttribute, getLongAttribute, getMapAttribute, getSetAttribute, getShortAttribute, getStringAttribute

Methods inherited from interface org.red5.server.api.IAttributeStore
getAttribute, getAttribute, getAttributeNames, getAttributes, hasAttribute, removeAttribute, removeAttributes, setAttribute, setAttributes, setAttributes, size

- Field Detail
  - RTMP_SESSION_ID
```
public static final String RTMP_SESSION_ID
```
    See Also:
    
    Constant Field Values
  - RTMP_HANDSHAKE
```
public static final String RTMP_HANDSHAKE
```
    See Also:
    
    Constant Field Values
  - RTMP_CONN_MANAGER
```
public static final String RTMP_CONN_MANAGER
```
    See Also:
    
    Constant Field Values
  - RTMP_HANDLER
```
public static final Object RTMP_HANDLER
```
  - RTMP_NON_ENCRYPTED
```
public static final byte RTMP_NON_ENCRYPTED
```
    Marker byte for standard or non-encrypted RTMP data.
    
    See Also:
    
    Constant Field Values
  - RTMP_ENCRYPTED
```
public static final byte RTMP_ENCRYPTED
```
    Marker byte for encrypted RTMP data.
    
    See Also:
    
    Constant Field Values
  - RTMP_ENCRYPTED_XTEA
```
public static final byte RTMP_ENCRYPTED_XTEA
```
    Marker byte for encrypted RTMP data XTEA. http://en.wikipedia.org/wiki/XTEA
    
    See Also:
    
    Constant Field Values
  - RTMP_ENCRYPTED_BLOWFISH
```
public static final byte RTMP_ENCRYPTED_BLOWFISH
```
    Marker byte for encrypted RTMP data using Blowfish. http://en.wikipedia.org/wiki/Blowfish_(cipher)
    
    See Also:
    
    Constant Field Values
  - RTMP_ENCRYPTED_UNK
```
public static final byte RTMP_ENCRYPTED_UNK
```
    Unknown type 0x0a, seen on youtube
    
    See Also:
    
    Constant Field Values
  - RTMPE_CIPHER_IN
```
public static final String RTMPE_CIPHER_IN
```
    Cipher for RTMPE input
    
    See Also:
    
    Constant Field Values
  - RTMPE_CIPHER_OUT
```
public static final String RTMPE_CIPHER_OUT
```
    Cipher for RTMPE output
    
    See Also:
    
    Constant Field Values
  - MAX_RESERVED_STREAMS
```
public static final double MAX_RESERVED_STREAMS
```
    See Also:
    
    Constant Field Values
  - handler
```
protected transient IRTMPHandler handler
```
    RTMP events handler
  - maxInactivity
```
protected volatile int maxInactivity
```
    Maximum time in ms after which a client is disconnected because of inactivity.
  - bytesReadInterval
```
protected long bytesReadInterval
```
    Data read interval
  - nextBytesRead
```
protected long nextBytesRead
```
    Number of bytes to read next.
  - maxHandlingTimeout
```
protected long maxHandlingTimeout
```
    Maximum time in milliseconds allowed to process received message
  - limitType
```
protected int limitType
```
    Bandwidth limit type / enforcement. (0=hard,1=soft,2=dynamic)
  - state
```
protected RTMP state
```
    Protocol state
  - decoderLock
```
protected transient Semaphore decoderLock
```
  - encoderLock
```
protected transient Semaphore encoderLock
```
  - decoderState
```
protected transient RTMPDecodeState decoderState
```
  - scheduler
```
protected transient ThreadPoolTaskScheduler scheduler
```
    Scheduling service
  - executor
```
protected transient ThreadPoolTaskExecutor executor
```
    Thread pool for message handling.
  - deadlockGuardScheduler
```
protected transient ThreadPoolTaskScheduler deadlockGuardScheduler
```
    Thread pool for guarding deadlocks.
  - running
```
protected final AtomicBoolean running
```
    Keep-alive worker flag
- Constructor Detail
  - RTMPConnection
```
@ConstructorProperties(value="type")
public RTMPConnection(String type)
```
    Creates anonymous RTMP connection without scope.
    
    Parameters:
    
    type - Connection type
- Method Detail
  - getId
```
public int getId()
```
  - setId
```
@Deprecated
public void setId(int clientId)
```
    Deprecated.
  - setHandler
```
public void setHandler(IRTMPHandler handler)
```
  - getHandler
```
public IRTMPHandler getHandler()
```
  - getState
```
public RTMP getState()
```
  - getStateCode
```
public byte getStateCode()
```
  - setStateCode
```
public void setStateCode(byte code)
```
  - getIoSession
```
public org.apache.mina.core.session.IoSession getIoSession()
```
  - getDecoderLock
```
public Semaphore getDecoderLock()
```
    Returns:
    
    the decoderLock
  - getEncoderLock
```
public Semaphore getEncoderLock()
```
    Returns:
    
    the decoderLock
  - getDecoderState
```
public RTMPDecodeState getDecoderState()
```
    Returns:
    
    the decoderState
  - setBandwidth
```
public void setBandwidth(int mbits)
```
    Sets the bandwidth using a mbit/s value.
    
    Specified by:
    
    setBandwidth in interface IConnection
    
    Parameters:
    
    mbits - target
  - getTimer
```
public int getTimer()
```
    Returns a usable timestamp for written packets.
    
    Returns:
    
    timestamp
  - open
```
public void open()
```
    Opens the connection.
  - connect
```
public boolean connect(IScope newScope,
                       Object[] params)
```
    Description copied from class: BaseConnection
    
    Connect to another scope on server with given parameters
    
    Specified by:
    
    connect in interface IConnection
    
    Overrides:
    
    connect in class BaseConnection
    
    Parameters:
    
    newScope - New scope
    
    params - Parameters to connect with
    
    Returns:
    
    true on success, false otherwise
  - startWaitForHandshake
```
public void startWaitForHandshake()
```
    Start waiting for a valid handshake.
  - setup
```
public void setup(String host,
                  String path,
                  Map<String,Object> params)
```
    Initialize connection.
    
    Parameters:
    
    host - Connection host
    
    path - Connection path
    
    params - Params passed from client
  - getEncoding
```
public IConnection.Encoding getEncoding()
```
    Return AMF protocol encoding used by this connection.
    
    Specified by:
    
    getEncoding in interface IConnection
    
    Returns:
    
    AMF encoding used by connection
  - getNextAvailableChannelId
```
public int getNextAvailableChannelId()
```
    Getter for next available channel id.
    
    Returns:
    
    Next available channel id
  - isChannelUsed
```
public boolean isChannelUsed(int channelId)
```
    Checks whether channel is used.
    
    Parameters:
    
    channelId - Channel id
    
    Returns:
    
    true if channel is in use, false otherwise
  - getChannel
```
public Channel getChannel(int channelId)
```
    Return channel by id.
    
    Parameters:
    
    channelId - Channel id
    
    Returns:
    
    Channel by id
  - closeChannel
```
public void closeChannel(int channelId)
```
    Closes channel.
    
    Parameters:
    
    channelId - Channel id
  - getStreams
```
protected Collection<IClientStream> getStreams()
```
    Getter for client streams.
    
    Returns:
    
    Client streams as array
  - getStreamsMap
```
public Map<Number,IClientStream> getStreamsMap()
```
    Specified by:
    
    getStreamsMap in interface IStreamCapableConnection
  - reserveStreamId
```
public Number reserveStreamId()
```
    Return a reserved stream id for use. According to FCS/FMS regulation, the base is 1.
    
    Specified by:
    
    reserveStreamId in interface IStreamCapableConnection
    
    Returns:
    
    Reserved stream id
  - reserveStreamId
```
public Number reserveStreamId(Number streamId)
```
    Return a reserved stream id for use with a preference for the one supplied.
    
    Specified by:
    
    reserveStreamId in interface IStreamCapableConnection
    
    Parameters:
    
    streamId - supplied stream id
    
    Returns:
    
    Reserved stream id
  - isValidStreamId
```
public boolean isValidStreamId(Number streamId)
```
    Returns whether or not a given stream id is valid.
    
    Parameters:
    
    streamId - stream id
    
    Returns:
    
    true if its valid, false if its invalid
  - isIdle
```
public boolean isIdle()
```
    Returns whether or not the connection has been idle for a maximum period.
    
    Returns:
    
    true if max idle period has been exceeded, false otherwise
  - isDisconnected
```
public boolean isDisconnected()
```
    Returns whether or not the connection is disconnected.
    
    Returns:
    
    true if connection state is RTMP.STATE_DISCONNECTED, false otherwise
  - newBroadcastStream
```
public IClientBroadcastStream newBroadcastStream(Number streamId)
```
    Create a broadcast stream.
    
    Specified by:
    
    newBroadcastStream in interface IStreamCapableConnection
    
    Parameters:
    
    streamId - Stream id
    
    Returns:
    
    New broadcast stream
  - newSingleItemSubscriberStream
```
public ISingleItemSubscriberStream newSingleItemSubscriberStream(Number streamId)
```
    Create a stream that can play only one item.
    
    Specified by:
    
    newSingleItemSubscriberStream in interface IStreamCapableConnection
    
    Parameters:
    
    streamId - Stream id
    
    Returns:
    
    New subscriber stream that can play only one item
  - newPlaylistSubscriberStream
```
public IPlaylistSubscriberStream newPlaylistSubscriberStream(Number streamId)
```
    Create a stream that can play a list.
    
    Specified by:
    
    newPlaylistSubscriberStream in interface IStreamCapableConnection
    
    Parameters:
    
    streamId - Stream id
    
    Returns:
    
    New stream that can play sequence of items
  - addClientStream
```
public void addClientStream(IClientStream stream)
```
  - removeClientStream
```
public void removeClientStream(Number streamId)
```
  - getUsedStreamCount
```
protected int getUsedStreamCount()
```
    Getter for used stream count.
    
    Returns:
    
    Value for property 'usedStreamCount'.
  - getStreamById
```
public IClientStream getStreamById(Number streamId)
```
    Get a stream by its id.
    
    Specified by:
    
    getStreamById in interface IStreamCapableConnection
    
    Parameters:
    
    streamId - Stream id
    
    Returns:
    
    Stream with given id
  - getStreamIdForChannelId
```
public Number getStreamIdForChannelId(int channelId)
```
    Return stream id for given channel id.
    
    Parameters:
    
    channelId - Channel id
    
    Returns:
    
    ID of stream that channel belongs to
  - getStreamByChannelId
```
public IClientStream getStreamByChannelId(int channelId)
```
    Return stream by given channel id.
    
    Parameters:
    
    channelId - Channel id
    
    Returns:
    
    Stream that channel belongs to
  - getChannelIdForStreamId
```
public int getChannelIdForStreamId(Number streamId)
```
    Return channel id for given stream id.
    
    Parameters:
    
    streamId - Stream id
    
    Returns:
    
    ID of channel that belongs to the stream
  - createOutputStream
```
public OutputStream createOutputStream(Number streamId)
```
    Creates output stream object from stream id. Output stream consists of audio, video, and data channels.
    
    Parameters:
    
    streamId - Stream id
    
    Returns:
    
    Output stream object
    
    See Also:
    
    OutputStream
  - close
```
public void close()
```
    Closes connection
    
    Specified by:
    
    close in interface IConnection
    
    Overrides:
    
    close in class BaseConnection
  - dispatchEvent
```
public void dispatchEvent(IEvent event)
```
    Dispatches event
    
    Specified by:
    
    dispatchEvent in interface IEventDispatcher
    
    Overrides:
    
    dispatchEvent in class BaseConnection
    
    Parameters:
    
    event - Event
  - sendPendingServiceCallsCloseError
```
public void sendPendingServiceCallsCloseError()
```
    When the connection has been closed, notify any remaining pending service calls that they have failed because the connection is broken. Implementors of IPendingServiceCallback may only deduce from this notification that it was not possible to read a result for this service call. It is possible that (1) the service call was never written to the service, or (2) the service call was written to the service and although the remote method was invoked, the connection failed before the result could be read, or (3) although the remote method was invoked on the service, the service implementor detected the failure of the connection and performed only partial processing. The caller only knows that it cannot be confirmed that the callee has invoked the service call and returned a result.
  - unreserveStreamId
```
public void unreserveStreamId(Number streamId)
```
    Unreserve this id for future use.
    
    Specified by:
    
    unreserveStreamId in interface IStreamCapableConnection
    
    Parameters:
    
    streamId - ID of stream to unreserve
  - deleteStreamById
```
public void deleteStreamById(Number streamId)
```
    Deletes the stream with the given id.
    
    Specified by:
    
    deleteStreamById in interface IStreamCapableConnection
    
    Parameters:
    
    streamId - ID of stream to delete
  - ping
```
public void ping(Ping ping)
```
    Handler for ping event.
    
    Parameters:
    
    ping - Ping event context
  - write
```
public abstract void write(Packet out)
```
    Write packet.
    
    Parameters:
    
    out - Packet
  - writeRaw
```
public abstract void writeRaw(org.apache.mina.core.buffer.IoBuffer out)
```
    Write raw byte buffer.
    
    Parameters:
    
    out - IoBuffer
  - updateBytesRead
```
protected void updateBytesRead()
```
    Update number of bytes to read next value.
  - receivedBytesRead
```
public void receivedBytesRead(int bytes)
```
    Read number of received bytes.
    
    Parameters:
    
    bytes - Number of bytes
  - getClientBytesRead
```
public long getClientBytesRead()
```
    Get number of bytes the client reported to have received.
    
    Specified by:
    
    getClientBytesRead in interface IConnection
    
    Overrides:
    
    getClientBytesRead in class BaseConnection
    
    Returns:
    
    Number of bytes
    
    See Also:
    
    BytesRead
  - invoke
```
public void invoke(IServiceCall call)
```
    Invokes service using remoting call object.
    
    Specified by:
    
    invoke in interface IServiceCapableConnection
    
    Parameters:
    
    call - Service call object
  - getTransactionId
```
public int getTransactionId()
```
    Generate next invoke id.
    
    Returns:
    
    Next invoke id for RPC
  - registerPendingCall
```
public void registerPendingCall(int invokeId,
                                IPendingServiceCall call)
```
    Register pending call (remote function call that is yet to finish).
    
    Parameters:
    
    invokeId - Deferred operation id
    
    call - Call service
  - invoke
```
public void invoke(IServiceCall call,
                   int channel)
```
    Invoke service using call and channel.
    
    Specified by:
    
    invoke in interface IServiceCapableConnection
    
    Parameters:
    
    call - Service call
    
    channel - Channel used
  - invoke
```
public void invoke(String method)
```
    Invoke method by name.
    
    Specified by:
    
    invoke in interface IServiceCapableConnection
    
    Parameters:
    
    method - Called method name
  - invoke
```
public void invoke(String method,
                   Object[] params)
```
    Invoke method with parameters.
    
    Specified by:
    
    invoke in interface IServiceCapableConnection
    
    Parameters:
    
    method - Method name
    
    params - Invocation parameters passed to method
  - invoke
```
public void invoke(String method,
                   IPendingServiceCallback callback)
```
    Invoke method by name with callback.
    
    Specified by:
    
    invoke in interface IServiceCapableConnection
    
    Parameters:
    
    method - Called method name
    
    callback - Callback
  - invoke
```
public void invoke(String method,
                   Object[] params,
                   IPendingServiceCallback callback)
```
    Invoke method with parameters.
    
    Specified by:
    
    invoke in interface IServiceCapableConnection
    
    Parameters:
    
    method - by name
    
    params - method params
    
    callback - callback
  - notify
```
public void notify(IServiceCall call)
```
    Notify method.
    
    Specified by:
    
    notify in interface IServiceCapableConnection
    
    Parameters:
    
    call - service call
  - notify
```
public void notify(IServiceCall call,
                   int channel)
```
    Notify method with channel id.
    
    Specified by:
    
    notify in interface IServiceCapableConnection
    
    Parameters:
    
    call - service call
    
    channel - channel id
  - notify
```
public void notify(String method)
```
    Notify method.
    
    Specified by:
    
    notify in interface IServiceCapableConnection
    
    Parameters:
    
    method - by name
  - notify
```
public void notify(String method,
                   Object[] params)
```
    Notify method with parameters.
    
    Specified by:
    
    notify in interface IServiceCapableConnection
    
    Parameters:
    
    method - by name
    
    params - method params
  - status
```
public void status(Status status)
```
    Sends a status object to the connection.
    
    Specified by:
    
    status in interface IServiceCapableConnection
    
    Parameters:
    
    status - Status
  - status
```
public void status(Status status,
                   int channel)
```
    Sends a status object to the connection on a given channel.
    
    Specified by:
    
    status in interface IServiceCapableConnection
    
    Parameters:
    
    status - Status
    
    channel - channel id
  - getReadBytes
```
public long getReadBytes()
```
    Total number of bytes read from the connection.
    
    Specified by:
    
    getReadBytes in interface IConnection
    
    Specified by:
    
    getReadBytes in class BaseConnection
    
    Returns:
    
    bytes read
  - getWrittenBytes
```
public long getWrittenBytes()
```
    Total number of bytes written to the connection.
    
    Specified by:
    
    getWrittenBytes in interface IConnection
    
    Specified by:
    
    getWrittenBytes in class BaseConnection
    
    Returns:
    
    bytes written
  - getPendingCall
```
public IPendingServiceCall getPendingCall(int invokeId)
```
    Get pending call service by id.
    
    Parameters:
    
    invokeId - Pending call service id
    
    Returns:
    
    Pending call service object
  - retrievePendingCall
```
public IPendingServiceCall retrievePendingCall(int invokeId)
```
    Retrieves and removes the pending call service by id.
    
    Parameters:
    
    invokeId - Pending call service id
    
    Returns:
    
    Pending call service object
  - createStreamName
```
protected String createStreamName()
```
    Generates new stream name.
    
    Returns:
    
    New stream name
  - writingMessage
```
protected void writingMessage(Packet message)
```
    Mark message as being written.
    
    Parameters:
    
    message - Message to mark
  - messageReceived
```
public void messageReceived()
```
    Increases number of read messages by one. Updates number of bytes read.
  - messageTypeToName
```
public String messageTypeToName(byte headerDataType)
```
  - handleMessageReceived
```
public void handleMessageReceived(Packet packet)
```
    Handle the incoming message.
    
    Parameters:
    
    packet - incoming message packet
  - onTaskAdded
```
public void onTaskAdded(ReceivedMessageTaskQueue queue)
```
    Specified by:
    
    onTaskAdded in interface IReceivedMessageTaskQueueListener
  - onTaskRemoved
```
public void onTaskRemoved(ReceivedMessageTaskQueue queue)
```
    Specified by:
    
    onTaskRemoved in interface IReceivedMessageTaskQueueListener
  - messageSent
```
public void messageSent(Packet message)
```
    Mark message as sent.
    
    Parameters:
    
    message - Message to mark
  - messageDropped
```
protected void messageDropped()
```
    Increases number of dropped messages.
  - currentQueueSize
```
protected int currentQueueSize()
```
    Returns the current received message queue size.
    
    Returns:
    
    current message queue size
  - getPendingVideoMessages
```
public long getPendingVideoMessages(Number streamId)
```
    Count of outgoing video messages not yet written.
    
    Specified by:
    
    getPendingVideoMessages in interface IStreamCapableConnection
    
    Overrides:
    
    getPendingVideoMessages in class BaseConnection
    
    Parameters:
    
    streamId - the id you want to know about
    
    Returns:
    
    pending messages for this streamId
  - sendSharedObjectMessage
```
public void sendSharedObjectMessage(String name,
                                    int currentVersion,
                                    boolean persistent,
                                    ConcurrentLinkedQueue<ISharedObjectEvent> events)
```
    Send a shared object message.
    
    Parameters:
    
    name - shared object name
    
    currentVersion - the current version
    
    persistent - toggle
    
    events - shared object events
  - ping
```
public void ping()
```
    Start measuring the round-trip time for a packet on the connection.
    
    Specified by:
    
    ping in interface IConnection
  - pingReceived
```
public void pingReceived(Ping pong)
```
    Marks that ping back was received.
    
    Parameters:
    
    pong - Ping object
  - getLastPingSentAndLastPongReceivedInterval
```
public int getLastPingSentAndLastPongReceivedInterval()
```
    Difference between when the last ping was sent and when the last pong was received.
    
    Returns:
    
    last interval of ping minus pong
  - getLastPingTime
```
public int getLastPingTime()
```
    Return round-trip time of last ping command.
    
    Specified by:
    
    getLastPingTime in interface IConnection
    
    Returns:
    
    round-trip time in milliseconds
  - setPingInterval
```
public void setPingInterval(int pingInterval)
```
    Setter for ping interval.
    
    Parameters:
    
    pingInterval - Interval in ms to ping clients. Set to 0 to disable ghost detection code.
  - setMaxInactivity
```
public void setMaxInactivity(int maxInactivity)
```
    Setter for maximum inactivity.
    
    Parameters:
    
    maxInactivity - Maximum time in ms after which a client is disconnected in case of inactivity.
  - onInactive
```
protected abstract void onInactive()
```
    Inactive state event handler.
  - setScheduler
```
public void setScheduler(ThreadPoolTaskScheduler scheduler)
```
    Sets the scheduler.
    
    Parameters:
    
    scheduler - scheduling service / thread executor
  - getScheduler
```
public ThreadPoolTaskScheduler getScheduler()
```
    Returns:
    
    the scheduler
  - getExecutor
```
public ThreadPoolTaskExecutor getExecutor()
```
  - setExecutor
```
public void setExecutor(ThreadPoolTaskExecutor executor)
```
  - getDeadlockGuardScheduler
```
public ThreadPoolTaskScheduler getDeadlockGuardScheduler()
```
    Thread pool for guarding deadlocks
    
    Returns:
    
    the deadlockGuardScheduler
  - setDeadlockGuardScheduler
```
public void setDeadlockGuardScheduler(ThreadPoolTaskScheduler deadlockGuardScheduler)
```
    Thread pool for guarding deadlocks
    
    Parameters:
    
    deadlockGuardScheduler - the deadlockGuardScheduler to set
  - registerDeferredResult
```
public void registerDeferredResult(DeferredResult result)
```
    Registers deferred result.
    
    Parameters:
    
    result - Result to register
  - unregisterDeferredResult
```
public void unregisterDeferredResult(DeferredResult result)
```
    Unregister deferred result
    
    Parameters:
    
    result - Result to unregister
  - rememberStreamBufferDuration
```
public void rememberStreamBufferDuration(int streamId,
                                         int bufferDuration)
```
  - setMaxHandshakeTimeout
```
public void setMaxHandshakeTimeout(int maxHandshakeTimeout)
```
    Set maximum time to wait for valid handshake in milliseconds.
    
    Parameters:
    
    maxHandshakeTimeout - Maximum time in milliseconds
  - getMaxHandlingTimeout
```
public long getMaxHandlingTimeout()
```
  - setMaxHandlingTimeout
```
public void setMaxHandlingTimeout(long maxHandlingTimeout)
```
  - getChannelsInitalCapacity
```
public int getChannelsInitalCapacity()
```
  - setChannelsInitalCapacity
```
public void setChannelsInitalCapacity(int channelsInitalCapacity)
```
  - getChannelsConcurrencyLevel
```
public int getChannelsConcurrencyLevel()
```
  - setChannelsConcurrencyLevel
```
public void setChannelsConcurrencyLevel(int channelsConcurrencyLevel)
```
  - getStreamsInitalCapacity
```
public int getStreamsInitalCapacity()
```
  - setStreamsInitalCapacity
```
public void setStreamsInitalCapacity(int streamsInitalCapacity)
```
  - getStreamsConcurrencyLevel
```
public int getStreamsConcurrencyLevel()
```
  - setStreamsConcurrencyLevel
```
public void setStreamsConcurrencyLevel(int streamsConcurrencyLevel)
```
  - getPendingCallsInitalCapacity
```
public int getPendingCallsInitalCapacity()
```
  - setPendingCallsInitalCapacity
```
public void setPendingCallsInitalCapacity(int pendingCallsInitalCapacity)
```
  - getPendingCallsConcurrencyLevel
```
public int getPendingCallsConcurrencyLevel()
```
  - setPendingCallsConcurrencyLevel
```
public void setPendingCallsConcurrencyLevel(int pendingCallsConcurrencyLevel)
```
  - getReservedStreamsInitalCapacity
```
public int getReservedStreamsInitalCapacity()
```
  - setReservedStreamsInitalCapacity
```
public void setReservedStreamsInitalCapacity(int reservedStreamsInitalCapacity)
```
  - getReservedStreamsConcurrencyLevel
```
public int getReservedStreamsConcurrencyLevel()
```
  - setReservedStreamsConcurrencyLevel
```
public void setReservedStreamsConcurrencyLevel(int reservedStreamsConcurrencyLevel)
```
  - setExecutorQueueSizeToDropAudioPackets
```
public void setExecutorQueueSizeToDropAudioPackets(Integer executorQueueSizeToDropAudioPackets)
```
    Specify the size of queue that will trigger audio packet dropping, disabled if it's 0
    
    Parameters:
    
    executorQueueSizeToDropAudioPackets - queue size
  - getProtocol
```
public String getProtocol()
```
    Description copied from interface: IConnection
    
    Returns the protocol type for this connection. eg. rtmp, rtmpt, http
    
    Specified by:
    
    getProtocol in interface IConnection
    
    Returns:
    
    protocol type
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class RTMPConnection

Nested Class Summary

Nested classes/interfaces inherited from interface org.red5.server.api.IConnection

Field Summary

Fields inherited from class org.red5.server.BaseConnection

Fields inherited from class org.red5.server.AttributeStore

Constructor Summary

Method Summary

Methods inherited from class org.red5.server.BaseConnection

Methods inherited from class org.red5.server.AttributeStore

Methods inherited from class java.lang.Object

Methods inherited from interface org.red5.server.api.IConnection

Methods inherited from interface org.red5.server.api.event.IEventHandler

Methods inherited from interface org.red5.server.api.event.IEventListener

Methods inherited from interface org.red5.server.api.ICastingAttributeStore

Methods inherited from interface org.red5.server.api.IAttributeStore

Field Detail

RTMP_SESSION_ID

RTMP_HANDSHAKE

RTMP_CONN_MANAGER

RTMP_HANDLER

RTMP_NON_ENCRYPTED

RTMP_ENCRYPTED

RTMP_ENCRYPTED_XTEA

RTMP_ENCRYPTED_BLOWFISH

RTMP_ENCRYPTED_UNK

RTMPE_CIPHER_IN

RTMPE_CIPHER_OUT

MAX_RESERVED_STREAMS

handler

maxInactivity

bytesReadInterval

nextBytesRead

maxHandlingTimeout

limitType

state

decoderLock

encoderLock

decoderState

scheduler

executor

deadlockGuardScheduler

running

Constructor Detail

RTMPConnection

Method Detail

getId

setId

setHandler

getHandler

getState

getStateCode

setStateCode

getIoSession

getDecoderLock

getEncoderLock

getDecoderState

setBandwidth

getTimer

open

connect

startWaitForHandshake

setup

getEncoding

getNextAvailableChannelId

isChannelUsed

getChannel

closeChannel

getStreams

getStreamsMap

reserveStreamId

reserveStreamId

isValidStreamId

isIdle

isDisconnected

newBroadcastStream

newSingleItemSubscriberStream

newPlaylistSubscriberStream

addClientStream

removeClientStream