Skip to content

Commit

Permalink
🐳 javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
iohao committed Oct 15, 2024
1 parent 86e16a3 commit f797386
Show file tree
Hide file tree
Showing 10 changed files with 150 additions and 6 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/*
* ioGame
* Copyright (C) 2021 - present 渔民小镇 (262610965@qq.com、luoyizhu@gmail.com) . All Rights Reserved.
* # iohao.com . 渔民小镇
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
/**
* 游戏对外服 - broker client - <a href="https://www.yuque.com/iohao/game/ivxsw5">获取游戏对外服的数据与扩展 - 实现</a>
* @author 渔民小镇
* @date 2024-10-15
*/
package com.iohao.game.external.core.broker.client.ext.impl;
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/*
* ioGame
* Copyright (C) 2021 - present 渔民小镇 (262610965@qq.com、luoyizhu@gmail.com) . All Rights Reserved.
* # iohao.com . 渔民小镇
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
/**
* 游戏对外服 - broker client - <a href="https://www.yuque.com/iohao/game/ivxsw5">获取游戏对外服的数据与扩展 - 接口</a>
* @author 渔民小镇
* @date 2024-10-15
*/
package com.iohao.game.external.core.broker.client.ext;
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
/*
* ioGame
* Copyright (C) 2021 - present 渔民小镇 (262610965@qq.com、luoyizhu@gmail.com) . All Rights Reserved.
* # iohao.com . 渔民小镇
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
/**
* 游戏对外服 - broker client
*
* @author 渔民小镇
* @date 2024-10-15
*/
package com.iohao.game.external.core.broker.client;
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/*
* ioGame
* Copyright (C) 2021 - present 渔民小镇 (262610965@qq.com、luoyizhu@gmail.com) . All Rights Reserved.
* # iohao.com . 渔民小镇
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
/**
* 游戏对外服 - broker client listener
* @author 渔民小镇
* @date 2024-10-15
*/
package com.iohao.game.external.core.broker.client.processor.listener;
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/*
* ioGame
* Copyright (C) 2021 - present 渔民小镇 (262610965@qq.com、luoyizhu@gmail.com) . All Rights Reserved.
* # iohao.com . 渔民小镇
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
/**
* 游戏对外服 - broker client processor
* @author 渔民小镇
* @date 2024-10-15
*/
package com.iohao.game.external.core.broker.client.processor;
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
/*
* ioGame
* Copyright (C) 2021 - present 渔民小镇 (262610965@qq.com、luoyizhu@gmail.com) . All Rights Reserved.
* # iohao.com . 渔民小镇
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
/**
* 游戏对外服 - 配置相关
*
* @author 渔民小镇
* @date 2024-10-15
*/
package com.iohao.game.external.core.config;
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
/**
* 游戏对外服 - core - micro - <a href="https://www.yuque.com/iohao/game/wotnhl">游戏对外服设计</a>,连接方式 TCP、UDP、WS 的支持
* 游戏对外服 - core micro <a href="https://www.yuque.com/iohao/game/wotnhl">设计</a>,连接方式 TCP、UDP、WS 的支持
*
* <pre>
* 目前,ioGame 框架已经提供了 TCP、WebSocket、UDP 的实现,其支持了连接方式的灵活切换。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
/**
* 游戏对外服 - core - micro - <a href="https://www.yuque.com/iohao/game/wotnhl">游戏对外服设计</a>,负责与外部通信,与真实用户(玩家)建立连接
*
* 游戏对外服 - core micro <a href="https://www.yuque.com/iohao/game/wotnhl">设计</a>,负责与外部通信,与真实用户(玩家)建立连接
*
* <pre>
* MicroBootstrap 接口
Expand All @@ -28,7 +27,6 @@
* MicroBootstrapFlow 接口
* 描述:与真实玩家连接【真实】服务器的启动流程,专为 MicroBootstrap 服务。开发者可通过此接口对服务器做编排,编排分为:构建时、新建连接时两种。框架提供了 TCP、WebSocket、UDP 的实现;开发者可以选择性的重写流程方法,来定制符合自身项目的业务。
* 职责:业务编排,也是开发者在扩展时接触最多的一个接口。
*
* </pre>
*
* @author 渔民小镇
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
/**
* 游戏对外服 - core - <a href="https://www.yuque.com/iohao/game/ea6geg">游戏对外服使用</a>
* <a href="https://www.yuque.com/iohao/game/ea6geg">游戏对外服</a> - core
* <p>
* 游戏对外服的职责
* <pre>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
/**
* 游戏对外服 - core - <a href="https://www.yuque.com/iohao/game/wg6lk7">UserSessions 和 UserSession</a>,UserSessions 是管理所有玩家连接的管理器,UserSession 玩家连接对象,与连接是 1:1 的关系,可取到对应的 userId、channel 等信息。
* 游戏对外服 - core <a href="https://www.yuque.com/iohao/game/wg6lk7">UserSessions 和 UserSession</a>,UserSessions 是管理所有玩家连接的管理器,UserSession 玩家连接对象,与连接是 1:1 的关系,可取到对应的 userId、channel 等信息。
*
* @author 渔民小镇
* @date 2024-09-13
Expand Down

0 comments on commit f797386

Please sign in to comment.