org.red5.server.api.scope
public interface IScope extends IBasicScope, org.springframework.core.io.support.ResourcePatternResolver, IServiceHandlerProvider
Modifier and Type | Field and Description |
---|---|
static String |
SEPARATOR
Scope separator
|
Modifier and Type | Method and Description |
---|---|
boolean |
addChildScope(IBasicScope scope)
Adds scope as a child scope.
|
boolean |
connect(IConnection conn)
Adds given connection to the scope
|
boolean |
connect(IConnection conn,
Object[] params)
Add given connection to the scope, overloaded for parameters pass case.
|
boolean |
createChildScope(String name)
Creates child scope with name given and returns success value.
|
void |
disconnect(IConnection conn)
Removes given connection from list of scope connections.
|
Object |
getAttribute(String name)
Get attribute by name
|
Set<String> |
getAttributeNames()
Return attribute names
|
Map<String,Object> |
getAttributes()
Return scope attributes
|
IBasicScope |
getBasicScope(ScopeType type,
String name)
Get a child scope by type and name.
|
Set<String> |
getBasicScopeNames(ScopeType type) |
IBroadcastScope |
getBroadcastScope(String name)
Return the broadcast scope for a given name
|
Set<IClient> |
getClients()
Get a set of connected clients.
|
Collection<Set<IConnection>> |
getConnections()
Get a connection iterator.
|
IContext |
getContext()
Returns scope context
|
String |
getContextPath()
Return context path.
|
IScopeHandler |
getHandler()
Return handler of the scope
|
IScope |
getScope(String name)
Return scope by name
|
Set<String> |
getScopeNames()
Get a set of the child scope names.
|
IScopeStatistics |
getStatistics()
Return statistics informations about the scope.
|
boolean |
hasAttribute(String name)
Whether or not an attribute exists, keyed by the given name
|
boolean |
hasChildScope(ScopeType type,
String name)
Checks whether scope has a child scope with given name and type
|
boolean |
hasChildScope(String name)
Check to see if this scope has a child scope matching a given name.
|
boolean |
hasHandler()
Checks whether scope has handler or not.
|
Set<IConnection> |
lookupConnections(IClient client)
Lookup connections.
|
boolean |
removeAttribute(String name)
Remove attribute by name
|
void |
removeChildren()
Removes all the child scopes
|
void |
removeChildScope(IBasicScope scope)
Removes scope from the children scope list.
|
boolean |
setAttribute(String name,
Object value)
Set attribute by name
|
getDepth, getName, getParent, getPath, getStore, getType, hasParent, isValid, setKeepDelay
dispatchEvent
handleEvent
notifyEvent
addEventListener, getEventListeners, removeEventListener
getResources
getClassLoader, getResource
getServiceHandler, getServiceHandlerNames, registerServiceHandler, unregisterServiceHandler
static final String SEPARATOR
boolean hasChildScope(String name)
name
- the name of the child scopetrue
if a child scope exists, otherwise
false
boolean hasChildScope(ScopeType type, String name)
type
- Child scope typename
- Child scope nametrue
if a child scope exists, otherwise
false
boolean createChildScope(String name)
true
on success, false
if given scope
already exists among children.name
- New child scope nametrue
if child scope was successfully creates,
false
otherwiseboolean addChildScope(IBasicScope scope)
true
on success,
false
if given scope is already a child of current.scope
- Scope giventrue
if child scope was successfully added,
false
otherwisevoid removeChildScope(IBasicScope scope)
scope
- Scope givenvoid removeChildren()
Set<String> getScopeNames()
IBroadcastScope getBroadcastScope(String name)
name
- IBasicScope getBasicScope(ScopeType type, String name)
type
- Child scope typename
- Name of the child scopeIScope getScope(String name)
name
- Scope nameSet<IClient> getClients()
IClient.getConnections()
method.IClient.getConnections(IScope)
Collection<Set<IConnection>> getConnections()
Set<IConnection> lookupConnections(IClient client)
client
- objectIContext getContext()
boolean hasHandler()
true
if scope has a handler, false
otherwiseIScopeHandler getHandler()
String getContextPath()
boolean connect(IConnection conn)
conn
- Given connectiontrue
on success, false
if given
connection already belongs to this scopeboolean connect(IConnection conn, Object[] params)
conn
- Given connectionparams
- Parameters passedtrue
on success, false
if given
connection already belongs to this scopevoid disconnect(IConnection conn)
conn
- Connection givenIScopeStatistics getStatistics()
boolean setAttribute(String name, Object value)
name
- value
- Object getAttribute(String name)
name
- boolean hasAttribute(String name)
name
- boolean removeAttribute(String name)
name
- Copyright © 2006-2012 The Red5 Project