|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.red5.server.AttributeStore
org.red5.server.PersistableAttributeStore
org.red5.server.BasicScope
public abstract class BasicScope
Generalizations of one of main Red5 object types, Scope. Basic scope is a persistable attribute store with event handling functionality
IScope,
Scope| Nested Class Summary | |
|---|---|
class |
BasicScope.EmptyBasicScopeIterator
Iterator for basic scope |
| Field Summary | |
|---|---|
protected int |
keepDelay
Set to amount of time (in seconds) the scope will be kept before being freed, after the last disconnect. |
protected boolean |
keepOnDisconnect
Set to true to prevent the scope from being freed upon disconnect. |
protected Set<IEventListener> |
listeners
List of event listeners |
protected IScope |
parent
Parent scope. |
protected String |
persistenceClass
Scope persistence storage type |
| Fields inherited from class org.red5.server.PersistableAttributeStore |
|---|
lastModified, name, path, persistent, store, type |
| Fields inherited from class org.red5.server.AttributeStore |
|---|
attributes |
| Fields inherited from interface org.red5.server.api.persistence.IPersistable |
|---|
TRANSIENT_PREFIX |
| Constructor Summary | |
|---|---|
BasicScope()
Creates unnamed scope |
|
BasicScope(IScope parent,
String type,
String name,
boolean persistent)
Constructor for basic scope |
|
| Method Summary | |
|---|---|
void |
addEventListener(IEventListener listener)
Add event listener to list of notified objects |
void |
dispatchEvent(IEvent event)
Dispatches event (notifies all listeners) |
int |
getDepth()
Get the scopes depth, how far down the scope tree is it. |
Iterator<IEventListener> |
getEventListeners()
Return listeners list iterator |
IScope |
getParent()
Get this scopes parent. |
String |
getPath()
Ruturn scope path |
boolean |
handleEvent(IEvent event)
Handles event. |
boolean |
hasEventListeners()
Returns true if there are event listeners attached to this scope. |
boolean |
hasParent()
Does this scope have a parent? You can think of scopes as of tree items where scope may have a parent and children (child). |
Iterator<IBasicScope> |
iterator()
Getter for subscopes list iterator. |
void |
notifyEvent(IEvent event)
Notifies listeners on event. |
void |
removeEventListener(IEventListener listener)
Remove event listener from list of listeners |
void |
setKeepDelay(int keepDelay)
Sets the amount of time to keep the scope available after the last disconnect. |
| Methods inherited from class org.red5.server.PersistableAttributeStore |
|---|
deserialize, getAttribute, getLastModified, getName, getStore, getType, isPersistent, modified, removeAttribute, removeAttributes, serialize, setAttribute, setAttributes, setAttributes, setName, setPath, setPersistent, setStore |
| Methods inherited from class org.red5.server.AttributeStore |
|---|
filterNull, getAttribute, getAttributeNames, getAttributes, getBoolAttribute, getByteAttribute, getDoubleAttribute, getIntAttribute, getListAttribute, getLongAttribute, getMapAttribute, getSetAttribute, getShortAttribute, getStringAttribute, hasAttribute |
| 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.IBasicScope |
|---|
getName, getType, lock, unlock |
| 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 |
| Methods inherited from interface org.red5.server.api.persistence.IPersistable |
|---|
deserialize, getLastModified, getStore, isPersistent, serialize, setName, setPath, setPersistent, setStore |
| Field Detail |
|---|
protected IScope parent
IScopeprotected Set<IEventListener> listeners
protected String persistenceClass
protected boolean keepOnDisconnect
protected int keepDelay
| Constructor Detail |
|---|
public BasicScope()
public BasicScope(IScope parent,
String type,
String name,
boolean persistent)
parent - Parent scopetype - Scope typename - Scope name. Used to identify scopes in application, must be unique among scopes of one levelpersistent - Whether scope is persistent| Method Detail |
|---|
public boolean hasParent()
hasParent in interface IBasicScopetrue if this scope has a parent, otherwise
falsepublic IScope getParent()
getParent in interface IBasicScopenull if this scope doesn't have a
parentpublic int getDepth()
getDepth in interface IBasicScopepublic String getPath()
getPath in interface IBasicScopegetPath in interface IPersistablegetPath in class PersistableAttributeStorepublic void setKeepDelay(int keepDelay)
setKeepDelay in interface IBasicScopekeepDelay - delaypublic void addEventListener(IEventListener listener)
addEventListener in interface IEventObservablelistener - Listening objectpublic void removeEventListener(IEventListener listener)
removeEventListener in interface IEventObservablelistener - Listener to removepublic Iterator<IEventListener> getEventListeners()
getEventListeners in interface IEventObservablepublic boolean hasEventListeners()
public boolean handleEvent(IEvent event)
handleEvent in interface IEventHandlerevent - Event context
public void notifyEvent(IEvent event)
notifyEvent in interface IEventListenerevent - Event to broadcastpublic void dispatchEvent(IEvent event)
dispatchEvent in interface IEventDispatcherevent - Event to dispatchpublic Iterator<IBasicScope> iterator()
iterator in interface Iterable<IBasicScope>
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||