Package org.red5.server.stream

Class AbstractStream

java.lang.Object

org.red5.server.stream.AbstractStream

All Implemented Interfaces:

IStream

Direct Known Subclasses:

AbstractClientStream

public abstract class AbstractStream
extends Object
implements IStream

Abstract base implementation of IStream. Contains codec information, stream name, scope, event handling, and provides stream start and stop operations.

See Also:

• IStream

Field Summary

Fields

Modifier and Type	Field	Description
protected IStreamCodecInfo	codecInfo	Stream audio and video codec information
protected long	creationTime	Timestamp the stream was created.
protected AtomicReference<Notify>	metaData	Stores the streams metadata
protected long	startTime	Timestamp the stream was started.
protected final AtomicReference<StreamState>	state	Current state
protected CopyOnWriteArraySet<PropertyChangeListener>	stateListeners	Contains PropertyChangeListeners registered with this stream and following its changes of state.

Constructor Summary

Constructors

Constructor	Description
AbstractStream()

Method Summary

Modifier and Type	Method	Description
void	addStateChangeListener(PropertyChangeListener listener)	Adds to the list of listeners tracking changes of the StreamState of this stream.
protected void	fireStateChange(StreamState oldState, StreamState newState)	Creates a new PropertyChangeEvent and delivers it to all currently registered state listeners.
IStreamCodecInfo	getCodecInfo()	Return codec information.
long	getCreationTime()	Returns timestamp at which the stream was created.
Notify	getMetaData()	Returns a copy of the metadata for the associated stream, if it exists.
String	getName()	Return stream name.
IScope	getScope()	Return scope.
long	getStartTime()	Returns timestamp at which the stream was started.
StreamState	getState()	Return stream state.
protected IStreamAwareScopeHandler	getStreamAwareHandler()	Return stream aware scope handler or null if scope is null.
void	removeStateChangeListener(PropertyChangeListener listener)	Removes from the list of listeners tracking changes of the StreamState of this stream.
void	setCodecInfo(IStreamCodecInfo codecInfo)	Setter for codec info.
void	setMetaData(Notify metaData)	Set the metadata.
void	setName(String name)	Setter for name.
void	setScope(IScope scope)	Setter for scope.
void	setState(StreamState newState)	Sets the stream state.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.red5.server.api.stream.IStream

close, start, stop

Field Details

codecInfo

protected IStreamCodecInfo codecInfo

Stream audio and video codec information

metaData

protected transient AtomicReference<Notify> metaData

Stores the streams metadata

stateListeners

protected transient CopyOnWriteArraySet<PropertyChangeListener> stateListeners

Contains PropertyChangeListeners registered with this stream and following its changes of state.

creationTime

protected long creationTime

Timestamp the stream was created.

startTime

protected long startTime

Timestamp the stream was started.

state

protected final transient AtomicReference<StreamState> state

Current state

Constructor Details

AbstractStream

public AbstractStream()

Method Details

fireStateChange

protected void fireStateChange(StreamState oldState,
 StreamState newState)

Creates a new PropertyChangeEvent and delivers it to all currently registered state listeners.

Parameters:

oldState - the StreamState we had before the change

newState - the StreamState we had after the change

addStateChangeListener

public void addStateChangeListener(PropertyChangeListener listener)

Adds to the list of listeners tracking changes of the StreamState of this stream.

Parameters:

listener - the listener to register

removeStateChangeListener

public void removeStateChangeListener(PropertyChangeListener listener)

Removes from the list of listeners tracking changes of the StreamState of this stream.

Parameters:

listener - the listener to remove

getName

public String getName()

Return stream name.

Specified by:

getName in interface IStream

Returns:

Stream name

getCodecInfo

public IStreamCodecInfo getCodecInfo()

Return codec information.

Specified by:

getCodecInfo in interface IStream

Returns:

Stream codec information

getMetaData

public Notify getMetaData()

Returns a copy of the metadata for the associated stream, if it exists.

Returns:

stream meta data

setMetaData

public void setMetaData(Notify metaData)

Set the metadata.

Parameters:

metaData - stream meta data

getScope

public IScope getScope()

Return scope.

Specified by:

getScope in interface IStream

Returns:

Scope

getCreationTime

public long getCreationTime()

Returns timestamp at which the stream was created.

Specified by:

getCreationTime in interface IStream

Returns:

creation timestamp

getStartTime

public long getStartTime()

Returns timestamp at which the stream was started.

Specified by:

getStartTime in interface IStream

Returns:

started timestamp

setName

public void setName(String name)

Setter for name.

Parameters:

name - Stream name

setCodecInfo

public void setCodecInfo(IStreamCodecInfo codecInfo)

Setter for codec info.

Parameters:

codecInfo - Codec info

setScope

public void setScope(IScope scope)

Setter for scope.

Parameters:

scope - Scope

getState

public StreamState getState()

Return stream state.

Returns:

StreamState

setState

public void setState(StreamState newState)

Sets the stream state.

Parameters:

newState - stream state

getStreamAwareHandler

protected IStreamAwareScopeHandler getStreamAwareHandler()

Return stream aware scope handler or null if scope is null.

Returns:

IStreamAwareScopeHandler implementation