nim_http Namespace Reference

NIM提供的HTTP工具 More...

Classes
class	HttpRequest
	NIM HTTP提供的http传输相关接口 More...

Typedefs
typedef std::function< void(bool, int)>	CompletedCallback
typedef std::function< void(bool, int, const std::string &)>	ResponseCallback
typedef std::function< void(double, double, double, double)>	ProgressCallback
typedef std::function< void(double, double)>	SpeedCallback
typedef std::function< void(double, double, double, double)>	TransferCallback

Functions
void	Init (const std::wstring &dll_path=L"")
void	Uninit ()
void	InitLog (const std::string &log_file_path)
bool	IsInitLog ()
void	SetGlobalProxy (NIMProxyType type, const std::string &host, short port, const std::string &user, const std::string &pass)
HttpRequestID	PostRequest (const HttpRequest &http_request)
void	RemoveRequest (HttpRequestID http_request_id)
std::string	GetResponseHead (HttpRequestID http_request_id)

Detailed Description

NIM提供的HTTP工具

Typedef Documentation

CompletedCallback

typedef std::function<void(bool, int)> nim_http::CompletedCallback

请求完成回调

Parameters

[out]	传输结果，true代表传输成功，false代表传输失败
[out]	http响应码

ProgressCallback

typedef std::function<void(double, double, double, double)> nim_http::ProgressCallback

请求过程回调

Parameters

[out]	总的待上传字节数
[out]	当前上传字节数
[out]	总的待下载字节数
[out]	当前下载字节数

ResponseCallback

typedef std::function<void(bool, int, const std::string&)> nim_http::ResponseCallback

请求响应回调

Parameters

[out]	传输结果，true代表传输成功，false代表传输失败
[out]	http响应码
[out]	http响应实体内容

SpeedCallback

typedef std::function<void(double, double)> nim_http::SpeedCallback

请求速度回报回调

Parameters

[out]	实时上传速度（字节每秒）
[out]	实时下载速度（字节每秒）

TransferCallback

typedef std::function<void(double, double, double, double)> nim_http::TransferCallback

请求汇报回调

Parameters

[out]	实际上传字节数
[out]	平均上传速度（字节每秒）
[out]	实际下载字节数
[out]	平均下载速度（字节每秒）

Function Documentation

GetResponseHead()

std::string nim_http::GetResponseHead

(

HttpRequestID

http_request_id

)

NIM HTTP 读取应答的http头信息,在任务完成的回调中调用，当回调完成后应答可能被释放,此时无法读取信息

Parameters

[in]

http_request_id

任务id

Returns

std::string HTTP应答头信息

Init()

void nim_http::Init

(

const std::wstring &

dll_path = L""

)

NIM HTTP 初始化

Parameters

[in]

dll_path

语音模块所在目录

Returns

void 无返回值

InitLog()

void nim_http::InitLog

(

const std::string &

log_file_path

)

NIM HTTP 设置日志文件路径

Parameters

[in]

log_file_path

日志文件保存路径

Returns

void 无返回值

IsInitLog()

bool nim_http::IsInitLog

(

)

NIM HTTP 是否设置过日志路径

Returns

bool 是否设置过日志路径

PostRequest()

HttpRequestID nim_http::PostRequest

(

const HttpRequest &

http_request

)

NIM HTTP 发起任务

Parameters

[in]

http_request

http任务句柄

Returns

HttpRequestID 任务id

RemoveRequest()

void nim_http::RemoveRequest

(

HttpRequestID

http_request_id

)

NIM HTTP 取消任务

Parameters

[in]

http_request_id

任务id

Returns

void 无返回值

SetGlobalProxy()

void nim_http::SetGlobalProxy	(	NIMProxyType	type,
		const std::string &	host,
		short	port,
		const std::string &	user,
		const std::string &	pass
	)

NIM HTTP 设置cpp封装层的全局代理

Parameters

[in]	type	代理类型NIMProxyType
[in]	host	代理地址
[in]	port	代理端口
[in]	user	代理账号
[in]	pass	代理密码

Returns

void

Uninit()

void nim_http::Uninit

(

)

NIM HTTP 反初始化

Returns

void 无返回值