com.litongjava.tio.core.TioConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tio-core Show documentation
There is a newer version: 3.7.3.v20241201-RELEASE
package com.litongjava.tio.core;

import java.nio.ByteOrder;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Set;
import java.util.concurrent.atomic.AtomicInteger;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.litongjava.tio.client.ClientTioConfig;
import com.litongjava.tio.core.cache.IpStatMapCacheRemovalListener;
import com.litongjava.tio.core.intf.AioHandler;
import com.litongjava.tio.core.intf.AioListener;
import com.litongjava.tio.core.intf.GroupListener;
import com.litongjava.tio.core.intf.Packet;
import com.litongjava.tio.core.intf.TioUuid;
import com.litongjava.tio.core.maintain.BsIds;
import com.litongjava.tio.core.maintain.ClientNodes;
import com.litongjava.tio.core.maintain.Groups;
import com.litongjava.tio.core.maintain.Ids;
import com.litongjava.tio.core.maintain.IpBlacklist;
import com.litongjava.tio.core.maintain.IpStats;
import com.litongjava.tio.core.maintain.Ips;
import com.litongjava.tio.core.maintain.Tokens;
import com.litongjava.tio.core.maintain.Users;
import com.litongjava.tio.core.ssl.SslConfig;
import com.litongjava.tio.core.stat.DefaultIpStatListener;
import com.litongjava.tio.core.stat.GroupStat;
import com.litongjava.tio.core.stat.IpStatListener;
import com.litongjava.tio.core.task.CloseRunnable;
import com.litongjava.tio.server.ServerTioConfig;
import com.litongjava.tio.utils.SystemTimer;
import com.litongjava.tio.utils.Threads;
import com.litongjava.tio.utils.cache.CacheFactory;
import com.litongjava.tio.utils.cache.RemovalListenerWrapper;
import com.litongjava.tio.utils.cache.mapcache.ConcurrentMapCacheFactory;
import com.litongjava.tio.utils.lock.MapWithLock;
import com.litongjava.tio.utils.lock.SetWithLock;
import com.litongjava.tio.utils.prop.MapWithLockPropSupport;

/**
 * 
 * @author tanyaowu 2016年10月10日 下午5:25:43
 */
public abstract class TioConfig extends MapWithLockPropSupport {
  static Logger log = LoggerFactory.getLogger(TioConfig.class);

  /**
   * 本jvm中所有的ServerTioConfig对象
   */
  public static final Set ALL_SERVER_GROUPCONTEXTS = new HashSet<>();
  /**
   * 本jvm中所有的ClientTioConfig对象
   */
  public static final Set ALL_CLIENT_GROUPCONTEXTS = new HashSet<>();
  /**
   * 本jvm中所有的TioConfig对象
   */
  public static final Set ALL_GROUPCONTEXTS = new HashSet<>();
  /**
   * 默认的接收数据的buffer size
   */
  public static final int READ_BUFFER_SIZE = Integer.getInteger("tio.default.read.buffer.size", 20480);
  private final static AtomicInteger ID_ATOMIC = new AtomicInteger();
  private ByteOrder byteOrder = ByteOrder.BIG_ENDIAN;
  public boolean isShortConnection = false;
  public SslConfig sslConfig = null;
  public boolean debug = false;
  public GroupStat groupStat = null;
  public boolean statOn = true;
  public PacketConverter packetConverter = null;

  /**
   * 缓存工厂
   */
  private CacheFactory cacheFactory;

  /**
   * 移除IP监听
   */
  @SuppressWarnings("rawtypes")
  private RemovalListenerWrapper ipRemovalListenerWrapper;
  /**
   * 启动时间
   */
  public long startTime = SystemTimer.currTime;
  /**
   * 是否用队列发送
   */
  public boolean useQueueSend = true;
  /**
   * 是否用队列解码（系统初始化时确定该值，中途不要变更此值，否则在切换的时候可能导致消息丢失）
   */
  public boolean useQueueDecode = false;
  /**
   * 心跳超时时间(单位: 毫秒)，如果用户不希望框架层面做心跳相关工作，请把此值设为0或负数
   */
  public long heartbeatTimeout = 1000 * 120;
  /**
   * 解码出现异常时，是否打印异常日志
   */
  public boolean logWhenDecodeError = false;
  public PacketHandlerMode packetHandlerMode = PacketHandlerMode.SINGLE_THREAD; // .queue;
  /**
   * 接收数据的buffer size
   */
  private int readBufferSize = READ_BUFFER_SIZE;
  private GroupListener groupListener = null;
  private TioUuid tioUuid = new DefaultTioUuid();
  public CloseRunnable closeRunnable;
  public ClientNodes clientNodes = new ClientNodes();
  public SetWithLock connections = new SetWithLock(new HashSet());
  public Groups groups = new Groups();
  public Users users = new Users();
  public Tokens tokens = new Tokens();
  public Ids ids = new Ids();
  public BsIds bsIds = new BsIds();
  public Ips ips = new Ips();
  public IpStats ipStats = new IpStats(this, null);;
  protected String id;
  /**
   * 解码异常多少次就把ip拉黑
   */
  protected int maxDecodeErrorCountForIp = 10;
  protected String name = "Untitled";
  private IpStatListener ipStatListener = DefaultIpStatListener.me;
  private boolean isStopped = false;
  /**
   * ip黑名单
   */
  public IpBlacklist ipBlacklist = null;
  public MapWithLock waitingResps = new MapWithLock(new HashMap());

  public TioConfig() {
  }

  public TioConfig(CacheFactory cacheFactory) {
    this.cacheFactory = cacheFactory;
  }

  public TioConfig(CacheFactory cacheFactory, RemovalListenerWrapper ipRemovalListenerWrapper) {
    this.cacheFactory = cacheFactory;
    this.ipRemovalListenerWrapper = ipRemovalListenerWrapper;
  }

  public TioConfig(String name) {
    this.name = name;
  }

  /**
   * 获取AioHandler对象
   * 
   * @return
   * @author: tanyaowu
   */
  public abstract AioHandler getAioHandler();

  /**
   * 获取AioListener对象
   * 
   * @return
   * @author: tanyaowu
   */
  public abstract AioListener getAioListener();

  /**
   *
   * @return
   * @author tanyaowu
   */
  public ByteOrder getByteOrder() {
    return byteOrder;
  }

  /**
   * @return the groupListener
   */
  public GroupListener getGroupListener() {
    return groupListener;
  }

  // /**
  // * 获取GroupStat对象
  // * @return
  // * @author: tanyaowu
  // */
  // public abstract GroupStat groupStat;

  /**
   *
   * @return
   * @author tanyaowu
   */
  public String getId() {
    return id;
  }

  /**
   * @return the tioUuid
   */
  public TioUuid getTioUuid() {
    return tioUuid;
  }

  /**
   * @return the syns
   */
  public MapWithLock getWaitingResps() {
    return waitingResps;
  }

  /**
   * @return the isEncodeCareWithChannelContext
   */
  // public boolean isEncodeCareWithChannelContext() {
  // return isEncodeCareWithChannelContext;
  // }

  // /**
  // * @return the isShortConnection
  // */
  // public boolean isShortConnection {
  // return isShortConnection;
  // }

  /**
   * @return the isStop
   */
  public boolean isStopped() {
    return isStopped;
  }

  /**
   *
   * @param byteOrder
   * @author tanyaowu
   */
  public void setByteOrder(ByteOrder byteOrder) {
    this.byteOrder = byteOrder;
  }

  /**
   * @param isEncodeCareWithChannelContext the isEncodeCareWithChannelContext to
   *                                       set
   */
  // public void setEncodeCareWithChannelContext(boolean
  // isEncodeCareWithChannelContext) {
  // this.isEncodeCareWithChannelContext = isEncodeCareWithChannelContext;
  // }

  /**
   * @param groupListener the groupListener to set
   */
  public void setGroupListener(GroupListener groupListener) {
    this.groupListener = groupListener;
  }

  /**
   * @param heartbeatTimeout the heartbeatTimeout to set
   */
  public void setHeartbeatTimeout(long heartbeatTimeout) {
    this.heartbeatTimeout = heartbeatTimeout;
  }

  public void setName(String name) {
    this.name = name;
  }

  public String getName() {
    return name;
  }

  /**
   * @param packetHandlerMode the packetHandlerMode to set
   */
  public void setPacketHandlerMode(PacketHandlerMode packetHandlerMode) {
    this.packetHandlerMode = packetHandlerMode;
  }

  /**
   * @param readBufferSize the readBufferSize to set
   */
  public void setReadBufferSize(int readBufferSize) {
    this.readBufferSize = Math.min(readBufferSize, TcpConst.MAX_DATA_LENGTH);
  }

  /**
   * @param isShortConnection the isShortConnection to set
   */
  public void setShortConnection(boolean isShortConnection) {
    this.isShortConnection = isShortConnection;
  }

  /**
   * @param isStop the isStop to set
   */
  public void setStopped(boolean isStopped) {
    this.isStopped = isStopped;
  }

  /**
   * @param tioUuid the tioUuid to set
   */
  public void setTioUuid(TioUuid tioUuid) {
    this.tioUuid = tioUuid;
  }

  public void setSslConfig(SslConfig sslConfig) {
    this.sslConfig = sslConfig;
  }

  public IpStatListener getIpStatListener() {
    return ipStatListener;
  }

  public void setIpStatListener(IpStatListener ipStatListener) {
    this.ipStatListener = ipStatListener;
    setDefaultIpRemovalListenerWrapper();
  }

  public GroupStat getGroupStat() {
    return groupStat;
  }

  /**
   * 是否用队列解码（系统初始化时确定该值，中途不要变更此值，否则在切换的时候可能导致消息丢失
   * 
   * @param useQueueDecode
   * @author tanyaowu
   */
  public void setUseQueueDecode(boolean useQueueDecode) {
    this.useQueueDecode = useQueueDecode;
  }

  /**
   * 是否用队列发送，可以随时切换
   * 
   * @param useQueueSend
   * @author tanyaowu
   */
  public void setUseQueueSend(boolean useQueueSend) {
    this.useQueueSend = useQueueSend;
  }

  /**
   * 是服务器端还是客户端
   * 
   * @return
   * @author tanyaowu
   */
  public abstract boolean isServer();

  public int getReadBufferSize() {
    return readBufferSize;
  }

  public boolean isSsl() {
    return sslConfig != null;
  }

  public void setCacheFactory(CacheFactory cacheFactory) {
    this.cacheFactory = cacheFactory;
  }

  public CacheFactory getCacheFactory() {
    return cacheFactory;
  }

  public void setIpRemovalListenerWrapper(RemovalListenerWrapper ipRemovalListenerWrapper) {
    this.ipRemovalListenerWrapper = ipRemovalListenerWrapper;
  }

  public RemovalListenerWrapper getIpRemovalListenerWrapper() {
    return ipRemovalListenerWrapper;
  }

  @SuppressWarnings({ "rawtypes", "unchecked" })
  public void setDefaultIpRemovalListenerWrapper() {
    this.ipRemovalListenerWrapper = new RemovalListenerWrapper();
    IpStatMapCacheRemovalListener ipStatMapCacheRemovalListener = new IpStatMapCacheRemovalListener(this, ipStatListener);
    ipRemovalListenerWrapper.setListener(ipStatMapCacheRemovalListener);
  }

  public void init() {
    if (cacheFactory == null) {
      // mapCacheFactory
      this.cacheFactory = ConcurrentMapCacheFactory.INSTANCE;
    }

    if (ipRemovalListenerWrapper == null) {
      setDefaultIpRemovalListenerWrapper();
    }

    ALL_GROUPCONTEXTS.add(this);
    if (this instanceof ServerTioConfig) {
      ALL_SERVER_GROUPCONTEXTS.add((ServerTioConfig) this);
    } else {
      ALL_CLIENT_GROUPCONTEXTS.add((ClientTioConfig) this);
    }

    if (ALL_GROUPCONTEXTS.size() > 20) {
      log.warn("You have created {} TioConfig objects, you might be misusing t-io.", ALL_GROUPCONTEXTS.size());
    }
    this.id = ID_ATOMIC.incrementAndGet() + "";

    if (this.ipStats == null) {
      this.ipStats = new IpStats(this, null);
    }
    closeRunnable = new CloseRunnable(Threads.getTioExecutor());
  }
}