nim_client_helper.h

浏览该文件的文档.

 
#ifndef _NIM_SDK_CPP_CLIENT_HELPER_H_
#define _NIM_SDK_CPP_CLIENT_HELPER_H_
 
#include <functional>
#include <list>
#include <map>
#include <string>
#include "nim_cpp_wrapper/nim_sdk_cpp_wrapper.h"
#include "nim_define_include.h"
#include "nim_wrapper_util/nim_json_util.h"
 
namespace nim {
static const uint64_t kDefaultEncryptUnencryptedDBThreshold{512 * 1024};
class Client;
struct NIM_SDK_CPPWRAPPER_DLL_API SDKConfig {
    // global_config
    std::string push_cer_name_;
    std::string push_token_;
    std::string database_encrypt_key_;
    NIMDatabaseCipherVersion database_cipher_version_;
    bool encrypt_unencrypted_db_{false};
    uint64_t encrypt_unencrypted_db_threshold_{kDefaultEncryptUnencryptedDBThreshold};
    bool preload_attach_;
    int preload_image_quality_;
    std::string preload_image_resize_;
    std::string preload_image_name_template_;
    NIMSDKLogLevel sdk_log_level_;
    bool sync_session_ack_;
    int login_max_retry_times_;
    int custom_timeout_;
    bool use_https_;
    bool team_notification_unread_count_;
    bool vchat_miss_unread_count_;
    bool reset_unread_count_when_recall_;
    bool upload_sdk_events_after_login_;
    bool animated_image_thumbnail_enabled_;
    bool client_antispam_;
    bool team_msg_ack_;
    bool team_query_tinfo_override_by_local_{true};
    uint32_t team_sync_tlist_limit_{2000};
    bool need_update_lbs_befor_relogin_;
    std::list<NIMMessageType> session_ignore_msg_types_;
    int custom_client_type_;
 
    /***********消息“已接收回执”发送配置 begin************/
    bool caching_markread_;
    uint32_t caching_markread_time_{0};
    uint32_t caching_markread_count_{0};
    /***********消息“已接收回执”发送配置 end************/
 
    /***********用户数据本地备份与恢复 begin************/
    bool enable_user_datafile_backup_;
    bool enable_user_datafile_restore_;
    bool enable_user_datafile_defrestoreproc_;
    std::string user_datafile_localbackup_folder_;
    /***********用户数据本地备份与恢复 end************/
 
    /***********IP地址族相关设置 begin************/
    int ip_protocol_version_;
    /***********地址族相关设置 end************/
 
    bool dedicated_cluste_flag_;
    int hand_shake_type_;
    int nego_key_neca_;
    int comm_neca_;
    std::string server_conf_file_path_;
    // private_server_setting 私有服务器配置（设置方法有两种，一个是配置以下信息，一个是通过配置server_conf_file_path_地址，信息从文件中读取）
    bool use_private_server_;
    std::string lbs_address_;
    std::list<std::string> lbs_backup_address_;
    std::string nos_lbs_address_;
    std::string default_link_address_;
    std::string default_link_address_ipv6_;
    std::string default_nos_upload_address_;
    std::string default_nos_upload_host_;
    std::string rsa_public_key_module_;
    int rsa_version_;
 
    std::string nego_key_neca_key_parta_;
    std::string nego_key_neca_key_partb_;
    int nego_key_neca_key_version_;
 
    std::string nos_download_address_;
    std::string nos_accelerate_host_;
    std::vector<std::string> nos_accelerate_host_list_;
    std::string nos_accelerate_address_;
 
    /***********IP地址族相关设置 begin************/
    std::string probe_ipv4_url_;
    std::string probe_ipv6_url_;
    /***********地址族相关设置 end************/
 
    std::map<int /*key */, int /*value */> sync_data_type_list_;
    std::list<std::string> http_dns_server_interface_;
    bool priority_use_cdn_host_;
    bool disable_app_nap_;
    bool cache_session_data_when_delete_;
    NIMSDKType sdk_type;
    std::string sdk_human_version;
 
    /***********融合存储相关************/
    std::string mock_refer_;
    std::string mock_ua_;
    int fcs_auth_type_;
    bool custom_enable_fcs_;
 
    /************** NTP 时间校对 ***************/
    uint32_t ntp_max_rtt_;
    uint32_t ntp_ideal_rtt_;
    uint32_t ntp_max_fetch_times_;
 
    SDKConfig();
 
public:
    void SetCustomClientType(int type);
    int GetCustomClientType() const;
 
private:
    friend class Client;
};
 
struct NIM_SDK_CPPWRAPPER_DLL_API OtherClientPres {
    std::string app_account_;
    NIMClientType client_type_;
    std::string client_os_;
    std::string mac_address_;
    std::string device_id_;
    int64_t login_time_;
    std::string custom_data_;
    int custom_client_type_;
    OtherClientPres()
        : login_time_(0)
        , custom_client_type_(0) {}
};
 
struct NIM_SDK_CPPWRAPPER_DLL_API LoginRes {
    NIMResCode res_code_;
    bool relogin_;
    NIMLoginStep login_step_;
    std::list<OtherClientPres> other_clients_;
    bool retrying_;
    LoginRes()
        : relogin_(false)
        , retrying_(true) {}
};
 
struct NIM_SDK_CPPWRAPPER_DLL_API KickoutRes {
    NIMClientType client_type_;
    NIMKickReason kick_reason_;
    std::string kickout_description_;
    int32_t custom_client_type_;
};
 
struct NIM_SDK_CPPWRAPPER_DLL_API MultiSpotLoginRes {
    NIMMultiSpotNotifyType notify_type_;
    std::list<OtherClientPres> other_clients_;
};
 
struct NIM_SDK_CPPWRAPPER_DLL_API KickOtherRes {
    NIMResCode res_code_;
    std::list<std::string> device_ids_;
};
 
bool NIM_SDK_CPPWRAPPER_DLL_API ParseOtherClientsPres(const nim_cpp_wrapper_util::Json::Value array_objs, std::list<OtherClientPres>& outs);
 
struct NIM_SDK_CPPWRAPPER_DLL_API LoginParams {
    std::string custom_data_;
    NIMAuthType auth_type_;
    std::string login_ex_;
    LoginParams()
        : auth_type_(kNIMAuthTypeDefault) {}
};
 
}  // namespace nim
 
#endif  //_NIM_SDK_CPP_CLIENT_HELPER_H_