EasyServer class

服务器

Inheritance

Constructors

EasyServer({required EasyServerConfig config})

Properties

config → EasyServerConfig
读取配置信息
no setter
hashCode → int
The hash code for this object.
no setterinherited
logTag → String
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

all(String route, Function handler) → void
挂载http服务的自定义的ALL请求路由，调用过此方法后过启动为web服务器
bindUser(EasyServerSession session, String uid, {required String? token, bool closeold = false}) → void
绑定用户信息到session。token是数据加解密密钥，为null时，使用EasyServerConfig.pwd进行加解密
broadcast({required String route, Map<String, dynamic>? data, bool binded = true}) → void
推送消息到本节点的session，binded为true时只推送给已经绑定过用户信息的session，binded为false时推送到所有的session
callRemote(String cluster, {required String route, Map<String, dynamic>? data, String? ucid, ClusterClientDispatcher? dispatcher}) → void
集群节点间远程路由异步调用，dispatcher为null时，从该集群的全部节点中随机选择一个节点
callRemoteForResult(String cluster, {required String route, Map<String, dynamic>? data, String? ucid, ClusterClientDispatcher? dispatcher}) → Future<EasyPacket>
集群节点间远程路由异步调用，并返回结果，dispatcher为null时，从该集群的全部节点中随机选择一个节点
close() → Future<void>
关闭服务器
clusterBroadcast(String cluster, {required String route, Map<String, dynamic>? data, bool binded = true}) → void
推送消息到集群的session，对该集群的全部节点进行遍历发送，binded为true时只推送给已经绑定过用户信息的session，binded为false时推送到所有的session
deleteChannel(String cid) → void
删除本节点的某个消息推送组
get(String route, Function handler) → void
挂载http服务的自定义的GET请求路由，调用过此方法后过启动为web服务器
getRequestIp(Request request) → String
获取请求的ip地址
httpRoute(String route, HttpRouteHandler handler, {HttpTokenConverter? tokenConverter, Map<String, Object>? responseHeaders}) → void
设置http服务的AES加密通讯的动态请求路由，调用过此方法后过启动为web服务器
httpUpload(String route, HttpUploadHandler handler, {required String destinationFolder(), String defaultMediatype = 'application/octet-stream', HttpTokenConverter? tokenConverter, Map<String, Object>? responseHeaders}) → void
设置http服务的AES加密通讯的文件上传路由，调用过此方法后过启动为web服务器
joinChannel(EasyServerSession session, String cid) → void
加入本节点的某个消息推送组
kickoutUser(String uid) → void
关闭uid对应的session
logDebug(List args) → void
inherited
logError(List args) → void
inherited
logFatal(List args) → void
inherited
logInfo(List args) → void
inherited
logTrace(List args) → void
inherited
logWarn(List args) → void
inherited
mount(String route, String path, {bool serveFilesOutsidePath = false, String? defaultDocument, bool listDirectories = false, bool useHeaderBytesForContentType = false, MimeTypeResolver? contentTypeResolver}) → void
挂载http服务的自定义的静态文件路由，调用过此方法后过启动为web服务器
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
post(String route, Function handler) → void
挂载http服务的自定义的POST请求路由，调用过此方法后过启动为web服务器
pushChannel(String cid, {required String route, Map<String, dynamic>? data}) → void
推送消息到本节点的某个消息推送组
pushChannelCustom(String cid, {required String route, Map<String, dynamic>? data, required WebsocketMessageCustomer customer}) → void
推送消息到本节点的某个消息推送组，每个成员的数据都进过差异处理
pushClusterChannel(String cluster, {required String route, Map<String, dynamic>? data, required String ucid, ClusterClientDispatcher? dispatcher}) → void
推送消息到集群的某个消息推送组，dispatcher为null时，对该集群的全部节点进行遍历发送
pushClusterSession(String cluster, {required String route, Map<String, dynamic>? data, required String ucid, ClusterClientDispatcher? dispatcher}) → void
推送消息到集群的某个session，dispatcher为null时，对该集群的全部节点进行遍历发送
pushHeartick(EasyServerSession session, EasyPacket heartick) → void
推送心跳包消息到本节点的指定session
pushInitiate(EasyServerSession session) → void
推送初始化消息到本节点的指定session
pushResponse(EasyServerSession session, EasyPacket request, {required EasyPacket response}) → void
响应本节点的某个session的请求
pushSession(String uid, {required String route, Map<String, dynamic>? data}) → void
推送消息到本节点的某个session
pushSessionBatch(List<String> uids, {required String route, Map<String, dynamic>? data}) → void
推送消息到本节点的某批session
quitChannel(EasyServerSession session, String cid) → void
退出本节点的某个消息推送组
setListener({ServerHeartListener? serverHeartListener, SessionCloseListener? sessionCloseListener}) → void
设置事件监听器
start() → Future<void>
开启服务器，当设置过http路由时启动为web服务器。否则启动为websocket服务器
toString() → String
A string representation of this object.
inherited
unbindUser(EasyServerSession session) → void
解绑session的用户信息
websocketRemote(String route, WebsocketRouteHandler handler) → void
设置websocket服务的MD5签名校验的远程监听器
websocketRoute(String route, WebsocketRouteHandler handler) → void
设置websocket服务的AES加密通讯的路由监听器

Operators

operator ==(Object other) → bool
The equality operator.
inherited