Red5 API 之 IScope 接口的理解

IScope 接口定义了Red5中作用域对象.该对象维护了一个由一组客户端连接组成的上下文状态.通过作用域对象我们就可以很轻松的实现一个分

级访问,区域对象的共享的功能.那么,对于一个作用域对象它可以有父作用域对象,也可以有子作用域对象.如果一个客户端连接到了一个作用域

对象,同时也连接到了它的父作用域对象.通过作用域对象就可以访问资源,共享对象,视音频流等.作用域对象在应用程序中定义了一些组选项.

下面是作用域所有的名称:application,room,place,lobby.

下面简单介绍一下IScope接口的方法:
boolean addChildScope(IBasicScope scope)
描述:添加一个子作用域.如果添加成功返回True,如果添加的子作用域已经是该作用域的子作用域,那么返回False.
参数:scope 一个子作用域对象.
返回值:True添加成功,False添加失败,添加的子作用域已经是该作用域的子作用域.

boolean connect(IConnection conn)
描述:添加一个连接对象.
参数:conn一个连接对象.
返回值:True表示成功,如果该连接对象已经属于该作用域对象则返回False.

boolean connect(IConnection conn,Object[] params)
描述:添加一个连接对象,并传入相应的参数对象.
参数:conn连接对象.
params:参数对象.
返回值:True表示成功.如果该连接对象已经属于该作用域对象则返回False.

boolean createChildScope(String name)
描述:通过一个字符串名称创建一个子作用域对象.成功返回True,如果该子对象已经存在本作用域中,则返回False.
参数:name 子作用域的名称.
返回值:True表示创建成功.如果该子对象已经存在本作用域中,则返回False.

void disconnect(IConnection conn)
描述:从该作用域对象的连接对象列表中删除一个指定的连接对象.这样就会把所有提供该连接对象的客户端和本作用域断开连接.
参数:提供的连接对象..

IBasicScope getBasicScope(String type,String name)
描述:获得一个子作用域对象.
参数:type子作用域的类型.
name:子作用域的名称.
返回值:如果指定子作用域对象存在返回该对象,否则返回Null.

Iterator<String> getBasicScopeNames(String type)
描述:获得所有指定类型的子作用域.
参数:类型名称.
返回值:返回一个范型的迭代器,通过该迭代器可以获得所有子作用域对象.

Set<IClient> getClients()
描述:返回当前作用域对象中所有子作用域对象的范型集合.
返回值:所有子作用域对象的范型集合.

Iterator<IConnection> getConnections()
描述:获得本作用域所有连接对象的范型迭代器.
返回值:连接对象迭代器.

IContext getContext()
描述:返回本作用域上下文环境.
返回值:返回本作用域上文对象.

String getContextPath()
描述:返回上下文路径.
返回值:上下文路径.

IScopeHandler getHandler()
描述:获得该作用域对象的控制器对象.
返回值:作用域的控制器对象.

IScope getScope(String name)
描述:通过名称获得作用域对象.
参数:name 作用域对象名称.
返回值:指定名称的作用域对象.

Iterator<String> getScopeNames()
描述:获得所有子作用域的名称迭代器.
返回值:子作用域名称迭代器.

boolean hasChildScope(String name)
描述:判断当前作用域是否有指定名称的子作用域.
参数:name 子作用域的名称.
返回值:如果存在返回True,反之返回False.

boolean hasChildScope(String type, String name)
描述:通过指定类型和名称判断当前作用域是否有指定名称的子作用域.
参数:type 子作用域的类型.
name 子作用域的名称.
返回值:如果存在返回True,反之返回False.

boolean hasHandler()
描述:判断该作用域是否存在控制器.
返回值:存在返回True,反之返回False.

Set<IConnection> lookupConnections(IClient client)
描述:通过客户端对象,查找连接对象.
返回值:返回只读的连接对象集合的迭代器.

void removeChildScope(IBasicScope scope)
描述:删除指定的子作用域.
参数:子作用域对象.


以上内容只要来自官方文档,欢迎批评指正!谢谢