nim_global.h File Reference

辅助能力 接口头文件，包括内存管理和代理相关设置 More...

#include "nim_global_def.h"

Go to the source code of this file.

Functions
NIM_SDK_DLL_API void	nim_global_free_str_buf (char *str)
NIM_SDK_DLL_API void	nim_global_free_buf (void *data)
NIM_SDK_DLL_API void	nim_global_set_proxy (enum NIMProxyType type, const char *host, int port, const char *user, const char *password)
NIM_SDK_DLL_API void	nim_global_detect_proxy (enum NIMProxyType type, const char *host, int port, const char *user, const char *password, nim_global_detect_proxy_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void	nim_global_reg_exception_report_cb (const char *json_extension, nim_sdk_exception_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void	nim_global_get_sdk_cache_file_info_async (const char *login_id, const char *file_type, int64_t end_timestamp, const char *json_extension, nim_sdk_get_cache_file_info_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void	nim_global_del_sdk_cache_file_async (const char *login_id, const char *file_type, int64_t end_timestamp, const char *json_extension, nim_sdk_del_cache_file_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void	nim_global_sdk_feedback_async (const char *url, const char *json_extension, nim_sdk_feedback_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void	nim_global_reg_sdk_db_error_cb (nim_global_sdk_db_error_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void	nim_global_upload_sdk_log (const char *feedback_message, nim_global_upload_sdk_log_cb_func cb, const void *user_data)

Detailed Description

辅助能力 接口头文件，包括内存管理和代理相关设置

Copyright

(c) 2015-2017, NetEase Inc. All rights reserved

Author

Harrison

Date

2015/2/1

Function Documentation

nim_global_del_sdk_cache_file_async()

void nim_global_del_sdk_cache_file_async	(	const char *	login_id,
		const char *	file_type,
		int64_t	end_timestamp,
		const char *	json_extension,
		nim_sdk_del_cache_file_cb_func	cb,
		const void *	user_data
	)

删除sdk缓存文件

Parameters

[in]	login_id	查询的账号ID
[in]	file_type	文件类型，常量定义见nim_global_def.h 查询SDK文件缓存信息文件类型file_type
[in]	end_timestamp	删除时间截止点（查询全部填0）
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	nim_sdk_del_cache_file_cb_func回调函数定义见nim_global_def.h
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

Returns

void 无返回值

nim_global_detect_proxy()

void nim_global_detect_proxy	(	enum NIMProxyType	type,
		const char *	host,
		int	port,
		const char *	user,
		const char *	password,
		nim_global_detect_proxy_cb_func	cb,
		const void *	user_data
	)

测试代理。

Parameters

[in]	type	代理类型，见NIMProxyType定义,其中音视频和白板暂时只支持kNIMProxySocks5代理
[in]	host	代理地址
[in]	port	代理端口
[in]	user	代理用户名
[in]	password	代理密码
[in]	cb	回调函数,定义见nim_global_def.h
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

Returns

void 无返回值

nim_global_free_buf()

void nim_global_free_buf

(

void *

data

)

释放SDK内部分配的内存

Parameters

[in]

data

由SDK内部分配的内存

Returns

void 无返回值

nim_global_free_str_buf()

void nim_global_free_str_buf

(

char *

str

)

释放SDK内部分配的内存

Parameters

[in]

str

由SDK内部分配内存的字符串

Returns

void 无返回值

nim_global_get_sdk_cache_file_info_async()

void nim_global_get_sdk_cache_file_info_async	(	const char *	login_id,
		const char *	file_type,
		int64_t	end_timestamp,
		const char *	json_extension,
		nim_sdk_get_cache_file_info_cb_func	cb,
		const void *	user_data
	)

获取sdk缓存文件信息

Parameters

[in]	login_id	查询的账号ID
[in]	file_type	文件类型，常量定义见nim_global_def.h 查询SDK文件缓存信息文件类型file_type
[in]	end_timestamp	查询时间截止点（查询全部填0）
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	nim_sdk_get_cache_file_info_cb_func回调函数定义见nim_global_def.h
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

Returns

void 无返回值

nim_global_reg_exception_report_cb()

void nim_global_reg_exception_report_cb	(	const char *	json_extension,
		nim_sdk_exception_cb_func	cb,
		const void *	user_data
	)

注册输出系统环境异常的回调

Parameters

[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	nim_sdk_exception_cb_func回调函数定义见nim_global_def.h
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

Returns

void 无返回值

nim_global_reg_sdk_db_error_cb()

void nim_global_reg_sdk_db_error_cb	(	nim_global_sdk_db_error_cb_func	cb,
		const void *	user_data
	)

注册 SDK DB操作出错时的回调

Parameters

[in]	cb	nim_global_sdk_db_error_cb_func回调函数定义见nim_global_def.h
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

Returns

void 无返回值

nim_global_sdk_feedback_async()

void nim_global_sdk_feedback_async	(	const char *	url,
		const char *	json_extension,
		nim_sdk_feedback_cb_func	cb,
		const void *	user_data
	)

SDK 反馈

Parameters

[in]	url	开发者需将所需要反馈的文件（dump，应用日志等）上传至nos。
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	nim_sdk_feedback_cb_func回调函数定义见nim_global_def.h
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

Returns

void 无返回值

nim_global_set_proxy()

void nim_global_set_proxy	(	enum NIMProxyType	type,
		const char *	host,
		int	port,
		const char *	user,
		const char *	password
	)

设置SDK统一的网络代理。不需要代理时，type设置为kNIMProxyNone，其余参数都传空字符串（端口设为0）。有些代理不需要用户名和密码，相应参数也传空字符串。

Parameters

[in]	type	代理类型，见NIMProxyType定义,其中音视频和白板暂时只支持kNIMProxySocks5代理
[in]	host	代理地址
[in]	port	代理端口
[in]	user	代理用户名
[in]	password	代理密码

Returns

void 无返回值

nim_global_upload_sdk_log()

void nim_global_upload_sdk_log	(	const char *	feedback_message,
		nim_global_upload_sdk_log_cb_func	cb,
		const void *	user_data
	)

上传SDK日志到服务器

Parameters

[in]	feedback_message	反馈信息
[in]	cb	操作结果的回调函数
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

Returns

void