net.ymate.platform.serv.IClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ymate-platform-serv Show documentation
YMP Serv.
The newest version!
/*
 * Copyright 2007-2019 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.ymate.platform.serv;

import net.ymate.platform.serv.nio.INioCodec;

import java.io.Closeable;
import java.io.IOException;

/**
 * 客户端接口
 *
 * @param  监听器类型
 * @param     客户端编解码器接口类型
 * @author 刘镇 ([email protected]) on 15/10/15 上午10:21
 */
public interface IClient, CODEC extends INioCodec> extends Closeable {

    /**
     * 初始化客户端服务
     *
     * @param clientCfg        客户端配置
     * @param listener         事件适配器
     * @param codec            解码器
     * @param reconnectService 断线重连服务
     * @param heartbeatService 链路维护(心跳)服务
     */
    void initialize(IClientCfg clientCfg,
                    LISTENER listener,
                    CODEC codec,
                    IReconnectService reconnectService,
                    IHeartbeatService heartbeatService);

    /**
     * 连接远程服务端
     *
     * @throws IOException 可能产生的异常
     */
    void connect() throws IOException;

    /**
     * 重连远程服务端
     *
     * @throws IOException 可能产生的异常
     */
    void reconnect() throws IOException;

    /**
     * 是否已连接
     *
     * @return 返回true表示已连接
     */
    boolean isConnected();

    /**
     * 是否正在关闭
     *
     * @return 返回true表示正在关闭
     */
    boolean isClosing();

    /**
     * 获取客户端配置对象
     *
     * @return 返回客户端配置对象
     */
    IClientCfg clientCfg();

    /**
     * 获取监听器
     *
     * @param  监听器类型
     * @return 返回监听器接口实现类对象
     */
     T listener();

    /**
     * 向远程服务发送消息
     *
     * @param message 消息对象
     * @throws IOException 可能产生的异常
     */
    void send(Object message) throws IOException;

    /**
     * 更新会话活动状态
     */
    void touch();

    /**
     * 获取最后更新会话状态的时间(毫秒)
     *
     * @return 返回最后更新会话状态的时间(毫秒)
     */
    long lastTouchTime();
}