namespace linker.messenger.sforward.client
{
    public interface ISForwardClientStore
    {
        /// <summary>
        /// 穿透密钥
        /// </summary>
        public string SecretKey { get;  }

        /// <summary>
        /// 设置穿透密钥
        /// </summary>
        /// <param name="key"></param>
        /// <returns></returns>
        public bool SetSecretKey(string key);

        /// <summary>
        /// 穿透数量
        /// </summary>
        /// <returns></returns>
        public int Count();

        /// <summary>
        /// 获取穿透列表
        /// </summary>
        /// <returns></returns>
        public IEnumerable<SForwardInfo> Get();
        /// <summary>
        /// 获取穿透
        /// </summary>
        /// <param name="id"></param>
        /// <returns></returns>
        public SForwardInfo Get(long id);
        /// <summary>
        /// 获取穿透
        /// </summary>
        /// <param name="domain"></param>
        /// <returns></returns>
        public SForwardInfo Get(string domain);
        /// <summary>
        /// 获取穿透
        /// </summary>
        /// <param name="port"></param>
        /// <returns></returns>
        public SForwardInfo GetPort(int port);
        /// <summary>
        /// 添加穿透
        /// </summary>
        /// <param name="info"></param>
        /// <returns></returns>
        public bool Add(SForwardInfo info);
        /// <summary>
        /// 更新穿透
        /// </summary>
        /// <param name="id"></param>
        /// <param name="started"></param>
        /// <param name="msg"></param>
        /// <returns></returns>
        public bool Update(long id,bool started,string msg);
        /// <summary>
        /// 更新
        /// </summary>
        /// <param name="id"></param>
        /// <param name="started"></param>
        /// <returns></returns>
        public bool Update(long id,bool started);
        /// <summary>
        /// 更新
        /// </summary>
        /// <param name="id"></param>
        /// <param name="localMsg"></param>
        /// <returns></returns>
        public bool Update(long id,string localMsg);
        /// <summary>
        /// 删除穿透
        /// </summary>
        /// <param name="id"></param>
        /// <returns></returns>
        public bool Remove(long id);
    }
}