com.iohao.game.bolt.broker.client.external.ext.ExternalBizRegion Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bolt-external Show documentation

There is a newer version: 17.1.61

/*
 * ioGame
 * Copyright (C) 2021 - 2023  渔民小镇 （[email protected]、[email protected]） . All Rights Reserved.
 * # iohao.com . 渔民小镇
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package com.iohao.game.bolt.broker.client.external.ext;

import com.iohao.game.action.skeleton.core.exception.MsgException;
import com.iohao.game.bolt.broker.client.external.ext.impl.*;
import com.iohao.game.bolt.broker.client.kit.ExternalCommunicationKit;

import java.io.Serializable;

/**
 * 对外服业务扩展
 *  *     开发者可以通过实现这个接口，向游戏逻辑服提供一些
 *     1 只存在于游戏对外服中的数据
 *     2 只有游戏对外服可以做的事
 *
 *     框架提供了两个参考实现
 *     {@link  ExistUserExternalBizRegion} 查询用户（玩家）是否在线
 *     {@link  ForcedOfflineExternalBizRegion} 强制用户（玩家）下线
 *
 *     开发者扩展完后，需要添加到 {@link ExternalBizRegions#add(ExternalBizRegion)} 才会生效
 *
 *     使用请参考 {@link  ExternalCommunicationKit}
 * 
 *
 * @author 渔民小镇
 * @date 2022-07-27
 */
public interface ExternalBizRegion {
    /**
     * 业务码
     *      *     开发者扩展时，用正数的业务码
     * 
     *
     * @return 业务码
     */
    int getBizCode();

    /**
     * 业务处理
     *      *     返回的数据会存放到 ResponseCollectExternalItemMessage.data 中
     * 
     *
     * @param regionContext 对外服业务处理上下文
     * @return 业务数据，如果有需要传递给请求端的数据，可以在此返回
     * @throws MsgException e
     */
    Serializable request(ExternalBizRegionContext regionContext) throws MsgException;
}