索引
所有程序包|所有类和接口|序列化表格
A
- acquireCandidate(String) - 接口中的方法 top.wcpe.beacon.agent.api.BeaconScheduling
-
在指定小区内取一台可调度候选。
- acquireCandidate(String, String) - 接口中的方法 top.wcpe.beacon.agent.api.BeaconScheduling
-
在指定小区内取一台可调度候选,并携带业务用途说明。
- address() - 类中的方法 top.wcpe.beacon.agent.api.ServiceInstance
- AgentIdentity - top.wcpe.beacon.agent.api中的类
-
当前 agent 的身份。
- AgentIdentity(String, String, String, String, String) - 类的构造器 top.wcpe.beacon.agent.api.AgentIdentity
- AgentUnavailableException - top.wcpe.beacon.agent.api中的异常错误类
-
agent 门面尚未就绪(未初始化或已卸载)时抛出。
- AgentUnavailableException(String) - 异常错误类的构造器 top.wcpe.beacon.agent.api.AgentUnavailableException
- awaitRegistered(long) - 接口中的方法 top.wcpe.beacon.agent.api.BeaconAgent
-
有界等待 agent 首次注册成功(控制面权威应答返回、zone 已按响应回填)。
B
- BeaconAgent - top.wcpe.beacon.agent.api中的接口
-
Beacon agent 对业务插件暴露的总门面:读有效配置 + 查服务发现。
- BeaconAgentProvider - top.wcpe.beacon.agent.api中的类
-
Beacon agent 对外门面的获取入口。
- BeaconScheduling - top.wcpe.beacon.agent.api中的接口
-
本机调度 / 健康门面(FR-148):业务插件取调度候选与健康事实的唯一入口。
- build() - 类中的方法 top.wcpe.beacon.agent.api.DiscoveryQuery.Builder
- builder() - 类中的静态方法 top.wcpe.beacon.agent.api.DiscoveryQuery
C
- call(String, String, Object) - 接口中的方法 top.wcpe.beacon.agent.api.Messaging
-
请求-响应(RPC):发请求并立即返回 Future,目标回信后完成;超时则 Future 异常完成 (
TimeoutException)。 - candidatesInZone(String) - 接口中的方法 top.wcpe.beacon.agent.api.BeaconScheduling
-
列出指定小区当前候选快照(本地缓存,O(1) 读,可在主线程调用)。
- CandidateView - top.wcpe.beacon.agent.api中的类
-
调度候选的只读快照视图(FR-148)。
- CandidateView(String, String, int, HealthLevel, int, int) - 类的构造器 top.wcpe.beacon.agent.api.CandidateView
- capacity() - 类中的方法 top.wcpe.beacon.agent.api.ServiceInstance
- chosen() - 类中的方法 top.wcpe.beacon.agent.api.ScheduleResult
-
选中的候选;为 null 表示本次调度失败(见
ScheduleResult.failReason())。 - config() - 接口中的方法 top.wcpe.beacon.agent.api.BeaconAgent
-
有效配置只读视图。
- ConfigChangeListener - top.wcpe.beacon.agent.api中的接口
-
有效配置变更回调。
- connected() - 接口中的方法 top.wcpe.beacon.agent.api.BeaconAgent
-
agent 当前是否已连上控制面。
- CONTROL_PLANE - 枚举类 中的枚举常量 top.wcpe.beacon.agent.api.DataSource
-
数据来自控制面在线刷新(最近一次候选刷新成功)。
- CONTROL_PLANE - 枚举类 中的枚举常量 top.wcpe.beacon.agent.api.DecisionSource
-
控制面在线决策(正常路径,traceId 为服务端 traceId)。
D
- dataIds() - 接口中的方法 top.wcpe.beacon.agent.api.EffectiveConfig
-
列出当前所有有效配置项的 dataId。
- dataSource() - 接口中的方法 top.wcpe.beacon.agent.api.BeaconScheduling
-
当前数据来源状态与快照年龄。
- DataSource - top.wcpe.beacon.agent.api中的枚举类
-
候选 / 健康视图当前的数据来源(FR-148)。
- DataSourceState - top.wcpe.beacon.agent.api中的类
-
本机候选缓存当前的数据来源状态与快照年龄(FR-148)。
- DataSourceState(DataSource, boolean, long) - 类的构造器 top.wcpe.beacon.agent.api.DataSourceState
- DecisionSource - top.wcpe.beacon.agent.api中的枚举类
-
一次调度决策的来源(FR-148)。
- DEGRADED - 枚举类 中的枚举常量 top.wcpe.beacon.agent.api.HealthLevel
-
亚健康:degradedMin ≤ score < healthyMin,仍可调度、仅排序靠后。
- discovery() - 接口中的方法 top.wcpe.beacon.agent.api.BeaconAgent
-
服务发现查询(同步 HTTP,请在异步线程调用)。
- Discovery - top.wcpe.beacon.agent.api中的接口
-
服务发现查询。
- DiscoveryQuery - top.wcpe.beacon.agent.api中的类
-
服务发现查询条件(不可变,经
DiscoveryQuery.Builder构造)。 - DiscoveryQuery.Builder - top.wcpe.beacon.agent.api中的类
-
DiscoveryQuery构造器。
E
- EffectiveConfig - top.wcpe.beacon.agent.api中的接口
-
有效配置只读视图。
- effectiveMd5() - 接口中的方法 top.wcpe.beacon.agent.api.BeaconAgent
-
当前有效配置整体 md5;尚无有效配置时为空。
F
- failReason() - 类中的方法 top.wcpe.beacon.agent.api.ScheduleResult
-
失败原因码(如
no_candidate/zone_not_found);成功为 null。 - format(String) - 接口中的方法 top.wcpe.beacon.agent.api.EffectiveConfig
-
取某 dataId 的格式(yaml / properties / json);不存在返回空。
- fresh() - 类中的方法 top.wcpe.beacon.agent.api.DataSourceState
-
快照年龄是否在阈值内(默认 ≤ 10 分钟为 true;超龄仍可用但标 false)。
G
- get() - 类中的静态方法 top.wcpe.beacon.agent.api.BeaconAgentProvider
-
获取 Beacon agent 门面。
- group() - 类中的方法 top.wcpe.beacon.agent.api.AgentIdentity
-
控制面解析的大区;未解析时为空。
- group() - 类中的方法 top.wcpe.beacon.agent.api.DiscoveryQuery
- group() - 类中的方法 top.wcpe.beacon.agent.api.ServiceInstance
- group(String) - 类中的方法 top.wcpe.beacon.agent.api.DiscoveryQuery.Builder
H
- handle(String, Object) - 接口中的方法 top.wcpe.beacon.agent.api.TopicHandler
-
处理一条主题消息。
- handle(IncomingMessage) - 接口中的方法 top.wcpe.beacon.agent.api.MessageHandler
-
处理一条收到的消息。
- HealthLevel - top.wcpe.beacon.agent.api中的枚举类
-
健康等级(FR-147)。
- healthOf(String) - 接口中的方法 top.wcpe.beacon.agent.api.BeaconScheduling
-
查询某台服务器的健康视图(本地候选缓存快照)。
- HealthView - top.wcpe.beacon.agent.api中的类
-
某台服务器的健康视图快照(FR-147 / FR-148)。
- HealthView(String, int, HealthLevel, boolean, List<String>, long) - 类的构造器 top.wcpe.beacon.agent.api.HealthView
- HEALTHY - 枚举类 中的枚举常量 top.wcpe.beacon.agent.api.HealthLevel
-
健康:score ≥ healthyMin,正常可调度。
I
- identity() - 接口中的方法 top.wcpe.beacon.agent.api.BeaconAgent
-
当前 agent 身份(namespace/serverId/role/group/zone)。
- IncomingMessage - top.wcpe.beacon.agent.api中的接口
-
收到的一条跨服消息(按类型分发给
MessageHandler)。 - instancesInGroup(String) - 接口中的方法 top.wcpe.beacon.agent.api.Discovery
-
列出某大区(group)下全部在线实例。
- instancesInZone(String, String) - 接口中的方法 top.wcpe.beacon.agent.api.Discovery
-
列出某 zone 下的在线实例(拓扑视角便捷方法)。
- isAvailable() - 类中的静态方法 top.wcpe.beacon.agent.api.BeaconAgentProvider
-
agent 是否已就绪(业务插件可据此先行判断,避免触发异常)。
- isAvailable() - 接口中的方法 top.wcpe.beacon.agent.api.Messaging
-
模块是否可用(已启用且 Redis 已连上)。
- isRequest() - 接口中的方法 top.wcpe.beacon.agent.api.IncomingMessage
-
本消息是否为 RPC 请求(可经
IncomingMessage.reply(Object)回信)。
L
- level() - 类中的方法 top.wcpe.beacon.agent.api.CandidateView
-
健康等级。
- level() - 类中的方法 top.wcpe.beacon.agent.api.HealthView
-
健康等级。
- ListenerHandle - top.wcpe.beacon.agent.api中的接口
-
监听器注销句柄。
- lobbyClusterMember() - 类中的方法 top.wcpe.beacon.agent.api.ServiceInstance
-
该子服是否属于 namespace 全局 LobbyCluster。
- LOCAL_FALLBACK - 枚举类 中的枚举常量 top.wcpe.beacon.agent.api.DecisionSource
-
控制面不可用时 agent 依本地候选快照做的降级决策(fail-static,traceId 为本地 traceId)。
- LOCAL_SNAPSHOT - 枚举类 中的枚举常量 top.wcpe.beacon.agent.api.DataSource
-
控制面不可用,数据来自最后一次落盘快照(含重启后恢复,fail-static)。
M
- maxOnline() - 类中的方法 top.wcpe.beacon.agent.api.CandidateView
-
容量上限。
- md5(String) - 接口中的方法 top.wcpe.beacon.agent.api.EffectiveConfig
-
取某 dataId 的单项 md5;不存在返回空。
- MessageHandler - top.wcpe.beacon.agent.api中的接口
-
按类型分发的消息处理器(函数式接口)。
- messaging() - 接口中的方法 top.wcpe.beacon.agent.api.BeaconAgent
-
跨服消息中间件门面(FR-26):定向 / RPC / 主题 / 按玩家寻址的通用传输。
- Messaging - top.wcpe.beacon.agent.api中的接口
-
跨服消息中间件门面(FR-26 / ADR-0016):对③层业务插件暴露与内容无关的通用传输。
N
- namespace() - 类中的方法 top.wcpe.beacon.agent.api.AgentIdentity
-
环境(prod / test)。
- namespace() - 类中的方法 top.wcpe.beacon.agent.api.DiscoveryQuery
- namespace(String) - 类中的方法 top.wcpe.beacon.agent.api.DiscoveryQuery.Builder
O
- on(String, MessageHandler) - 接口中的方法 top.wcpe.beacon.agent.api.Messaging
-
注册按消息类型分发的处理器(收消息入口)。
- onChange(ConfigChangeListener) - 接口中的方法 top.wcpe.beacon.agent.api.EffectiveConfig
-
注册有效配置变更监听(apply 后回调,携带变更的 dataId 集合)。
- onConfigChanged(Set<String>, String) - 接口中的方法 top.wcpe.beacon.agent.api.ConfigChangeListener
- onlineCount() - 类中的方法 top.wcpe.beacon.agent.api.CandidateView
-
在线人数(仅展示,不参与调用方决策)。
- onTopologyChanged() - 接口中的方法 top.wcpe.beacon.agent.api.TopologyListener
-
拓扑发生变更(上线 / 下线 / 改派);业务侧据此重查发现端点。
P
- payload() - 接口中的方法 top.wcpe.beacon.agent.api.IncomingMessage
-
业务负载(泛型树:Map/List/字符串/数字/布尔/null)。
- playerCount() - 类中的方法 top.wcpe.beacon.agent.api.ServiceInstance
-
在线人数(仅展示,不参与任何决策)。
- publish(String, Object) - 接口中的方法 top.wcpe.beacon.agent.api.Messaging
-
主题发布(可丢广播,FR-180 / ADR-0065):向发送者 namespace 当前全部在线服 fan-out 一条广播 (含发送者自身),topic 落 msg_type,接收方按
Messaging.subscribe(java.lang.String, top.wcpe.beacon.agent.api.TopicHandler)注册的同名处理器分发。 - publish(String, Object, String) - 接口中的方法 top.wcpe.beacon.agent.api.Messaging
-
主题发布 · zone 级定向(FR-180 重载,接口只增不改、守二进制兼容):只向发送者 namespace 内指定
zone的当前在线服 fan-out;其余语义同Messaging.publish(String, Object)(可丢、不补投、不出信任边界)。
Q
- query(DiscoveryQuery) - 接口中的方法 top.wcpe.beacon.agent.api.Discovery
-
按条件过滤在线实例。
R
- raw(String) - 接口中的方法 top.wcpe.beacon.agent.api.EffectiveConfig
-
取某 dataId 的合并后原始文本;不存在返回空。
- reasons() - 类中的方法 top.wcpe.beacon.agent.api.HealthView
-
不可调度原因码(只读,可空为空表)。
- register(BeaconAgent) - 类中的静态方法 top.wcpe.beacon.agent.api.BeaconAgentProvider
-
由 agent 实现层在 ENABLE 阶段注册;业务插件不应调用。
- remove() - 接口中的方法 top.wcpe.beacon.agent.api.ListenerHandle
-
注销监听器。
- reply(Object) - 接口中的方法 top.wcpe.beacon.agent.api.IncomingMessage
-
回信(仅 RPC 请求有效;非请求调用无副作用)。
- role() - 类中的方法 top.wcpe.beacon.agent.api.AgentIdentity
-
角色(bukkit / bungee),由壳层固定。
- role() - 类中的方法 top.wcpe.beacon.agent.api.DiscoveryQuery
- role() - 类中的方法 top.wcpe.beacon.agent.api.ServiceInstance
- role(String) - 类中的方法 top.wcpe.beacon.agent.api.DiscoveryQuery.Builder
- roster() - 接口中的方法 top.wcpe.beacon.agent.api.Discovery
-
全量玩家位置名册(FR-31):返回 玩家名 → 所在 serverId 的只读快照。
- rosterInZone(String, String) - 接口中的方法 top.wcpe.beacon.agent.api.Discovery
-
zone 过滤后的玩家位置名册(FR-31):仅含落在该 group/zone 下子服的玩家。
S
- sampledAtMs() - 类中的方法 top.wcpe.beacon.agent.api.HealthView
-
该视图对应的采样时刻(毫秒)。
- schedulable() - 类中的方法 top.wcpe.beacon.agent.api.HealthView
-
是否可调度。
- ScheduleResult - top.wcpe.beacon.agent.api中的类
-
一次
acquireCandidate的决策结果(FR-148)。 - ScheduleResult(CandidateView, String, DecisionSource, String) - 类的构造器 top.wcpe.beacon.agent.api.ScheduleResult
- scheduling() - 接口中的方法 top.wcpe.beacon.agent.api.BeaconAgent
-
本机调度 / 健康门面(FR-148):取调度候选与健康事实的唯一入口。
- score() - 类中的方法 top.wcpe.beacon.agent.api.CandidateView
-
健康分(0-100)。
- score() - 类中的方法 top.wcpe.beacon.agent.api.HealthView
-
健康分(0-100)。
- selfHealth() - 接口中的方法 top.wcpe.beacon.agent.api.BeaconScheduling
-
查询本服自身健康视图(随每次指标上报响应刷新,约 5s 新鲜度)。
- send(String, String, Object) - 接口中的方法 top.wcpe.beacon.agent.api.Messaging
-
定向发送(fire-and-forget,可靠送达):写入目标服收件流,目标离线则上线后补收。
- sendToPlayer(String, String, Object) - 接口中的方法 top.wcpe.beacon.agent.api.Messaging
-
按玩家寻址:解析玩家当前所在服后定向发送(依赖 beacon-proxy 维护的玩家名册)。
- serverId() - 类中的方法 top.wcpe.beacon.agent.api.AgentIdentity
-
本机唯一身份,环境内唯一。
- serverId() - 类中的方法 top.wcpe.beacon.agent.api.CandidateView
-
候选子服 serverId。
- serverId() - 类中的方法 top.wcpe.beacon.agent.api.HealthView
-
服务器 serverId。
- serverId() - 类中的方法 top.wcpe.beacon.agent.api.ServiceInstance
- ServiceInstance - top.wcpe.beacon.agent.api中的类
-
服务发现返回的单个在线实例(只读值对象)。
- ServiceInstance(String, String, String, String, String, String, String, int, int, int) - 类的构造器 top.wcpe.beacon.agent.api.ServiceInstance
- ServiceInstance(String, String, String, String, String, String, String, int, int, int, boolean) - 类的构造器 top.wcpe.beacon.agent.api.ServiceInstance
- ServiceInstance(String, String, String, String, String, String, String, int, int, int, boolean, boolean) - 类的构造器 top.wcpe.beacon.agent.api.ServiceInstance
- snapshotAgeMs() - 类中的方法 top.wcpe.beacon.agent.api.DataSourceState
-
最近一次候选快照落点距今毫秒;从无快照时为
Long.MAX_VALUE。 - source() - 类中的方法 top.wcpe.beacon.agent.api.DataSourceState
-
当前数据来源。
- source() - 接口中的方法 top.wcpe.beacon.agent.api.IncomingMessage
-
发起方 serverId(可能为 null)。
- source() - 类中的方法 top.wcpe.beacon.agent.api.ScheduleResult
-
决策来源。
- status() - 类中的方法 top.wcpe.beacon.agent.api.ServiceInstance
-
健康状态:online / lost / offline。
- subscribe(String, TopicHandler) - 接口中的方法 top.wcpe.beacon.agent.api.Messaging
-
主题订阅(FR-180 / ADR-0065):登记本地按 topic 分发的处理器,接收经
Messaging.publish(java.lang.String, java.lang.Object)广播到本服的该主题消息。
T
- tag(String, String) - 类中的方法 top.wcpe.beacon.agent.api.DiscoveryQuery.Builder
-
追加一个自定义元数据过滤条件(key/value 任一为空则忽略)。
- tags() - 类中的方法 top.wcpe.beacon.agent.api.DiscoveryQuery
-
自定义元数据过滤条件(不可变;空表示不按 tag 过滤)。
- top.wcpe.beacon.agent.api - 程序包 top.wcpe.beacon.agent.api
- TopicHandler - top.wcpe.beacon.agent.api中的接口
-
主题消息处理器(函数式接口)。
- TopologyListener - top.wcpe.beacon.agent.api中的接口
-
拓扑变更回调(FR-29)。
- traceId() - 类中的方法 top.wcpe.beacon.agent.api.ScheduleResult
-
决策唯一标识:控制面决策为服务端 traceId,本地降级为本地 traceId。
- type() - 接口中的方法 top.wcpe.beacon.agent.api.IncomingMessage
-
业务消息类型。
U
- UNHEALTHY - 枚举类 中的枚举常量 top.wcpe.beacon.agent.api.HealthLevel
-
不健康:score < degradedMin,不可调度。
- unregister() - 类中的静态方法 top.wcpe.beacon.agent.api.BeaconAgentProvider
-
由 agent 实现层在 DISABLE 阶段注销;业务插件不应调用。
V
- valueOf(String) - 枚举类中的静态方法 top.wcpe.beacon.agent.api.DataSource
-
返回带有指定名称的该类的枚举常量。
- valueOf(String) - 枚举类中的静态方法 top.wcpe.beacon.agent.api.DecisionSource
-
返回带有指定名称的该类的枚举常量。
- valueOf(String) - 枚举类中的静态方法 top.wcpe.beacon.agent.api.HealthLevel
-
返回带有指定名称的该类的枚举常量。
- values() - 枚举类中的静态方法 top.wcpe.beacon.agent.api.DataSource
-
返回包含该枚举类的常量的数组, 顺序与声明这些常量的顺序相同
- values() - 枚举类中的静态方法 top.wcpe.beacon.agent.api.DecisionSource
-
返回包含该枚举类的常量的数组, 顺序与声明这些常量的顺序相同
- values() - 枚举类中的静态方法 top.wcpe.beacon.agent.api.HealthLevel
-
返回包含该枚举类的常量的数组, 顺序与声明这些常量的顺序相同
- version() - 类中的方法 top.wcpe.beacon.agent.api.ServiceInstance
W
- watch(TopologyListener) - 接口中的方法 top.wcpe.beacon.agent.api.Discovery
-
订阅拓扑变更(FR-29):同 namespace 内实例上线 / 下线 / 改派 zone 时回调 listener。
- weight() - 类中的方法 top.wcpe.beacon.agent.api.ServiceInstance
Z
- zone() - 类中的方法 top.wcpe.beacon.agent.api.AgentIdentity
-
控制面指派的小区;未指派时为空。
- zone() - 类中的方法 top.wcpe.beacon.agent.api.CandidateView
-
候选所在小区名。
- zone() - 类中的方法 top.wcpe.beacon.agent.api.DiscoveryQuery
- zone() - 类中的方法 top.wcpe.beacon.agent.api.ServiceInstance
- zone(String) - 类中的方法 top.wcpe.beacon.agent.api.DiscoveryQuery.Builder
- zoneDefaultEntry() - 类中的方法 top.wcpe.beacon.agent.api.ServiceInstance
-
该子服是否被指定为其小区(zone)的默认入口(FR-48)。
所有程序包|所有类和接口|序列化表格