org.red5.server

Class BaseConnection

java.lang.Object

org.red5.server.AttributeStore

org.red5.server.BaseConnection

All Implemented Interfaces:

IEventDispatcher, IEventHandler, IEventListener, IAttributeStore, ICastingAttributeStore, IConnection, ICoreObject, AttributeStoreMXBean

Direct Known Subclasses:

RTMPConnection

public abstract class BaseConnection
extends AttributeStore
implements IConnection

Base abstract class for connections. Adds connection specific functionality like work with clients to AttributeStore.

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 CopyOnWriteArraySet<IBasicScope>	basicScopes Set of basic scopes.
protected IClient	client Client bound to connection
protected CopyOnWriteArrayList<IConnectionListener>	connectionListeners Listeners
protected AtomicLong	droppedMessages Number of dropped messages
protected IConnection.Duty	duty Duty type
protected String	host Connection host
protected Map<String,Object>	params Connection params passed from client with NetConnection.connect call
protected String	path Path of scope client connected to
protected AtomicLong	readMessages Number of read messages
protected String	remoteAddress Connection remote address
protected List<String>	remoteAddresses Connection remote addresses
protected int	remotePort Remote port
protected Scope	scope Scope to which this connection belongs
protected String	sessionId Connection session identifier
protected IConnection.Type	type Connection type
protected AtomicLong	writtenMessages Number of written messages

Fields inherited from class org.red5.server.AttributeStore

attributes

Constructor Summary

Constructors

Constructor and Description
BaseConnection() Creates a new persistent base connection
BaseConnection(String type) Creates a new base connection with the given type.
BaseConnection(String type, String host, String remoteAddress, int remotePort, String path, String sessionId, Map<String,Object> params) Creates a new base connection with the given parameters.

Method Summary

Modifier and Type	Method and Description
void	addListener(IConnectionListener listener) Adds a listener to this object
void	close() Closes connection
boolean	connect(IScope newScope) Connect to another scope on server
boolean	connect(IScope newScope, Object[] params) Connect to another scope on server with given parameters
void	dispatchEvent(IEvent event) Dispatches event
boolean	equals(Object obj)
Iterator<IBasicScope>	getBasicScopes() Get the basic scopes this connection has subscribed.
IClient	getClient() Get the client object associated with this connection.
long	getClientBytesRead() Return number of written bytes the client reports to have received.
Map<String,Object>	getConnectParams() Return connection parameters
long	getDroppedMessages() Total number of messages that have been dropped.
IConnection.Duty	getDuty() Get the duty for this connection; this is not meant nor expected to remain static.
String	getHost() Get the hostname that the client is connected to.
Semaphore	getLock()
String	getPath() Get the path for this connection.
long	getPendingMessages() Count of outgoing messages not yet written.
long	getPendingVideoMessages(Number streamId) Count of outgoing video messages not yet written.
abstract long	getReadBytes() Total number of bytes read from the connection.
long	getReadMessages() Total number of messages read from the connection.
String	getRemoteAddress() Get the IP address the client is connected from.
List<String>	getRemoteAddresses() Get the IP addresses the client is connected from.
int	getRemotePort() Get the port the client is connected from.
IScope	getScope() Return the current scope.
String	getSessionId() Get the session id, this may be null.
Number	getStreamId() Returns the current stream id.
String	getType() Get the connection type.
abstract long	getWrittenBytes() Total number of bytes written to the connection.
long	getWrittenMessages() Total number of messages written to the connection.
boolean	handleEvent(IEvent event) Handles event
int	hashCode()
void	initialize(IClient client) Initializes client
boolean	isClosed() Returns whether or not a connection is closed.
boolean	isConnected() Check whether connection is alive
boolean	isReaderIdle() Returns whether or not the reader is idle.
boolean	isWriterIdle() Returns whether or not the writer is idle.
void	notifyEvent(IEvent event) Notified on event
void	registerBasicScope(IBroadcastScope basicScope) Registers basic scope
void	registerBasicScope(SharedObjectScope basicScope) Registers basic scope
void	removeListener(IConnectionListener listener) Removes the listener from this object
void	setClient(IClient client) Sets the Client.
void	setDuty(IConnection.Duty duty)
void	setStreamId(Number id) Sets the current stream id.
void	unregisterBasicScope(IBasicScope basicScope) Unregister basic scope

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, toString, wait, wait, wait

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

getEncoding, getLastPingTime, getProtocol, ping, setBandwidth

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

type

protected final IConnection.Type type

Connection type

duty

protected volatile IConnection.Duty duty

Duty type

host

protected volatile String host

Connection host

remoteAddress

protected volatile String remoteAddress

Connection remote address

remoteAddresses

protected volatile List<String> remoteAddresses

Connection remote addresses

remotePort

protected volatile int remotePort

Remote port

path

protected volatile String path

Path of scope client connected to

sessionId

protected final String sessionId

Connection session identifier

readMessages

protected AtomicLong readMessages

Number of read messages

writtenMessages

protected AtomicLong writtenMessages

Number of written messages

droppedMessages

protected AtomicLong droppedMessages

Number of dropped messages

params

protected volatile Map<String,Object> params

Connection params passed from client with NetConnection.connect call

client

protected volatile IClient client

Client bound to connection

scope

protected transient volatile Scope scope

Scope to which this connection belongs

basicScopes

protected transient CopyOnWriteArraySet<IBasicScope> basicScopes

Set of basic scopes. The scopes may be of shared object or broadcast stream type.

connectionListeners

protected transient CopyOnWriteArrayList<IConnectionListener> connectionListeners

Listeners

Constructor Detail

BaseConnection

@ConstructorProperties(value="persistent")
public BaseConnection()

Creates a new persistent base connection

BaseConnection

@ConstructorProperties(value="type")
public BaseConnection(String type)

Creates a new base connection with the given type.

Parameters:

type - Connection type

BaseConnection

@ConstructorProperties(value={"type","host","remoteAddress","remotePort","path","sessionId"})
public BaseConnection(String type,
                                                                                                                    String host,
                                                                                                                    String remoteAddress,
                                                                                                                    int remotePort,
                                                                                                                    String path,
                                                                                                                    String sessionId,
                                                                                                                    Map<String,Object> params)

Creates a new base connection with the given parameters.

Parameters:

type - Connection type

host - Host

remoteAddress - Remote address

remotePort - Remote port

path - Scope path on server

sessionId - Session id

params - Params passed from client

Method Detail

addListener

public void addListener(IConnectionListener listener)

Adds a listener to this object

Specified by:

addListener in interface IConnection

Parameters:

listener - connection listener

removeListener

public void removeListener(IConnectionListener listener)

Removes the listener from this object

Specified by:

removeListener in interface IConnection

Parameters:

listener - connection listener

getLock

public Semaphore getLock()

Returns:

lock for changing state operations

getStreamId

public Number getStreamId()

Returns the current stream id.

Specified by:

getStreamId in interface IConnection

Returns:

stream id

setStreamId

public void setStreamId(Number id)

Sets the current stream id.

Specified by:

setStreamId in interface IConnection

Parameters:

id - stream id

initialize

public void initialize(IClient client)

Initializes client

Specified by:

initialize in interface IConnection

Parameters:

client - Client bound to connection

getType

public String getType()

Get the connection type.

Specified by:

getType in interface IConnection

Returns:

string containing one of connection types

getDuty

public IConnection.Duty getDuty()

Get the duty for this connection; this is not meant nor expected to remain static.

Specified by:

getDuty in interface IConnection

Returns:

duty type

setDuty

public void setDuty(IConnection.Duty duty)

getHost

public String getHost()

Get the hostname that the client is connected to. If they are connected to an IP, the IP address will be returned as a String.

Specified by:

getHost in interface IConnection

Returns:

String containing the hostname

getRemoteAddress

public String getRemoteAddress()

Get the IP address the client is connected from.

Specified by:

getRemoteAddress in interface IConnection

Returns:

The IP address of the client

getRemoteAddresses

public List<String> getRemoteAddresses()

Get the IP addresses the client is connected from. If a client is connected through RTMPT and uses a proxy to connect, this will contain all hosts the client used to connect to the server.

Specified by:

getRemoteAddresses in interface IConnection

Returns:

The IP addresses of the client

getRemotePort

public int getRemotePort()

Get the port the client is connected from.

Specified by:

getRemotePort in interface IConnection

Returns:

The port of the client

getPath

public String getPath()

Get the path for this connection. This is not updated if you switch scope.

Specified by:

getPath in interface IConnection

Returns:

path Connection path

getSessionId

public String getSessionId()

Get the session id, this may be null.

Specified by:

getSessionId in interface IConnection

Returns:

Session id

getConnectParams

public Map<String,Object> getConnectParams()

Return connection parameters

Specified by:

getConnectParams in interface IConnection

Returns:

connection parameters

setClient

public void setClient(IClient client)

Sets the Client.

Specified by:

setClient in interface IConnection

Parameters:

client - client

getClient

public IClient getClient()

Get the client object associated with this connection.

Specified by:

getClient in interface IConnection

Returns:

Client object

isConnected

public boolean isConnected()

Check whether connection is alive

Specified by:

isConnected in interface IConnection

Returns:

true if connection is bound to scope, false otherwise

connect

public boolean connect(IScope newScope)

Connect to another scope on server

Specified by:

connect in interface IConnection

Parameters:

newScope - New scope

Returns:

true on success, false otherwise

connect

public boolean connect(IScope newScope,
                       Object[] params)

Connect to another scope on server with given parameters

Specified by:

connect in interface IConnection

Parameters:

newScope - New scope

params - Parameters to connect with

Returns:

true on success, false otherwise

getScope

public IScope getScope()

Return the current scope.

Specified by:

getScope in interface IConnection

Returns:

scope

close

public void close()

Closes connection

Specified by:

close in interface IConnection

notifyEvent

public void notifyEvent(IEvent event)

Notified on event

Specified by:

notifyEvent in interface IEventListener

Parameters:

event - Event

dispatchEvent

public void dispatchEvent(IEvent event)

Dispatches event

Specified by:

dispatchEvent in interface IEventDispatcher

Parameters:

event - Event

handleEvent

public boolean handleEvent(IEvent event)

Handles event

Specified by:

handleEvent in interface IEventHandler

Parameters:

event - Event

Returns:

true if associated scope was able to handle event, false otherwise

getBasicScopes

public Iterator<IBasicScope> getBasicScopes()

Description copied from interface: IConnection

Get the basic scopes this connection has subscribed. This list will contain the shared objects and broadcast streams the connection connected to.

Specified by:

getBasicScopes in interface IConnection

Returns:

basic scopes

registerBasicScope

public void registerBasicScope(IBroadcastScope basicScope)

Registers basic scope

Parameters:

basicScope - Basic scope to register

registerBasicScope

public void registerBasicScope(SharedObjectScope basicScope)

Registers basic scope

Parameters:

basicScope - Basic scope to register

unregisterBasicScope

public void unregisterBasicScope(IBasicScope basicScope)

Unregister basic scope

Parameters:

basicScope - Unregister basic scope

getReadBytes

public abstract long getReadBytes()

Description copied from interface: IConnection

Total number of bytes read from the connection.

Specified by:

getReadBytes in interface IConnection

Returns:

bytes read

getWrittenBytes

public abstract long getWrittenBytes()

Description copied from interface: IConnection

Total number of bytes written to the connection.

Specified by:

getWrittenBytes in interface IConnection

Returns:

bytes written

getReadMessages

public long getReadMessages()

Description copied from interface: IConnection

Total number of messages read from the connection.

Specified by:

getReadMessages in interface IConnection

Returns:

messages read

getWrittenMessages

public long getWrittenMessages()

Description copied from interface: IConnection

Total number of messages written to the connection.

Specified by:

getWrittenMessages in interface IConnection

Returns:

messages written

getDroppedMessages

public long getDroppedMessages()

Description copied from interface: IConnection

Total number of messages that have been dropped.

Specified by:

getDroppedMessages in interface IConnection

Returns:

dropped messages

isReaderIdle

public boolean isReaderIdle()

Returns whether or not the reader is idle.

Returns:

queued messages

isWriterIdle

public boolean isWriterIdle()

Returns whether or not the writer is idle.

Returns:

queued messages

isClosed

public boolean isClosed()

Returns whether or not a connection is closed.

Returns:

true if closed

getPendingMessages

public long getPendingMessages()

Count of outgoing messages not yet written.

Specified by:

getPendingMessages in interface IConnection

Returns:

pending messages

getPendingVideoMessages

public long getPendingVideoMessages(Number streamId)

Count of outgoing video messages not yet written.

Parameters:

streamId - the id you want to know about

Returns:

pending messages for this streamId

getClientBytesRead

public long getClientBytesRead()

Return number of written bytes the client reports to have received. This is the last value of the BytesRead message received from a client.

Specified by:

getClientBytesRead in interface IConnection

Returns:

number of written bytes received by the client

See Also:

BytesRead

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object