NIM HTTP提供的传输相关C接口的说明文件 More...

#include "net/base/net_export.h"
#include "nim_tools_http_def.h"

Functions
NET_EXPORT void	nim_http_init ()

NET_EXPORT void	nim_http_uninit ()

NET_EXPORT void	nim_http_init_log (const char *log_file_path)

NET_EXPORT bool	nim_http_is_init_log ()

NET_EXPORT HttpRequestID	nim_http_post_request (HttpRequestHandle request_handle)

NET_EXPORT void	nim_http_remove_request (HttpRequestID http_request_id)

NET_EXPORT HttpRequestHandle	nim_http_create_download_file_request (const char url, const char download_file_path, nim_http_request_completed_cb complete_cb, const void *user_data)

NET_EXPORT HttpRequestHandle	nim_http_create_download_file_range_request (const char url, const char download_file_path, __int64 range_start, nim_http_request_completed_cb complete_cb, const void *user_data)

NET_EXPORT HttpRequestHandle	nim_http_create_request (const char url, const char post_body, size_t post_body_size, nim_http_request_response_cb response_cb, const void *user_data)

NET_EXPORT void	nim_http_add_request_header (HttpRequestHandle request_handle, const char key, const char value)

NET_EXPORT void	nim_http_set_request_progress_cb (HttpRequestHandle request_handle, nim_http_request_progress_cb progress_callback, const void *user_data)

NET_EXPORT void	nim_http_set_request_speed_cb (HttpRequestHandle request_handle, nim_http_request_speed_cb speed_callback, const void *user_data)

NET_EXPORT void	nim_http_set_request_transfer_cb (HttpRequestHandle request_handle, nim_http_request_transfer_cb transfer_callback, const void *user_data)

NET_EXPORT void	nim_http_set_request_method_as_post (HttpRequestHandle request_handle)

NET_EXPORT void	nim_http_set_timeout (HttpRequestHandle request_handle, int timeout_ms)

NET_EXPORT void	nim_http_set_low_speed (HttpRequestHandle request_handle, int low_speed_limit, int low_speed_time)

NET_EXPORT void	nim_http_set_proxy (HttpRequestHandle request_handle, int type, const char host, short port, const char user, const char *pass)

NET_EXPORT const char *const	nim_http_get_response_head (HttpRequestID http_request_id)

Detailed Description

NIM HTTP提供的传输相关C接口的说明文件

Copyright: (c) 2015-2016, NetEase Inc. All rights reserved

Author: towik

Date: 2015/4/30

Function Documentation

◆ nim_http_add_request_header()

void nim_http_add_request_header	(	HttpRequestHandle	request_handle,
		const char *	key,
		const char *	value
	)

NIM HTTP 创建任务

Parameters

[in]	request_handle	http任务句柄
[in]	key	头的key
[in]	value	头的value

Returns: void 无返回值

◆ nim_http_create_download_file_range_request()

HttpRequestHandle nim_http_create_download_file_range_request	(	const char *	url,
		const char *	download_file_path,
		__int64	range_start,
		nim_http_request_completed_cb	complete_cb,
		const void *	user_data
	)

NIM HTTP 创建下载文件任务，支持断点续传

Parameters

[in]	url	资源地址
[in]	download_file_path	下载文件保存的本地路径
[in]	range_start	下载文件的起始点
[in]	complete_cb	结束回调
[in]	user_data	自定义数据

Returns: HttpRequestHandle http任务句柄

◆ nim_http_create_download_file_request()

HttpRequestHandle nim_http_create_download_file_request	(	const char *	url,
		const char *	download_file_path,
		nim_http_request_completed_cb	complete_cb,
		const void *	user_data
	)

NIM HTTP 创建下载文件任务

Parameters

[in]	url	资源地址
[in]	download_file_path	下载文件保存的本地路径
[in]	complete_cb	结束回调
[in]	user_data	自定义数据

Returns: HttpRequestHandle http任务句柄

◆ nim_http_create_request()

HttpRequestHandle nim_http_create_request	(	const char *	url,
		const char *	post_body,
		size_t	post_body_size,
		nim_http_request_response_cb	response_cb,
		const void *	user_data
	)

NIM HTTP 创建任务

Parameters

[in]	url	资源地址
[in]	post_body	上传内容
[in]	post_body_size	上传内容大小
[in]	response_cb	结束回调，响应实体内容
[in]	user_data	自定义数据

Returns: HttpRequestHandle http任务句柄

◆ nim_http_get_response_head()

const char *const nim_http_get_response_head ( HttpRequestID http_request_id )

NIM HTTP 读取应答的http头信息

Parameters

[in] http_request_id 任务id

Returns: char* 头信息

◆ nim_http_init()

void nim_http_init ( )

NIM HTTP 初始化

Returns: void 无返回值

◆ nim_http_init_log()

void nim_http_init_log ( const char * log_file_path )

NIM HTTP 设置日志文件路径

Parameters

[in] log_file_path 日志文件保存路径

Returns: void 无返回值

◆ nim_http_is_init_log()

bool nim_http_is_init_log ( )

NIM HTTP 是否设置过日志路径

Returns: bool 是否设置过日志路径

◆ nim_http_post_request()

int nim_http_post_request ( HttpRequestHandle request_handle )

NIM HTTP 发起任务

Parameters

[in] request_handle http任务句柄

Returns: HttpRequestID 任务id

◆ nim_http_remove_request()

void nim_http_remove_request ( HttpRequestID http_request_id )

NIM HTTP 取消任务

Parameters

[in] http_request_id 任务id

Returns: void 无返回值

◆ nim_http_set_low_speed()

void nim_http_set_low_speed	(	HttpRequestHandle	request_handle,
		int	low_speed_limit,
		int	low_speed_time
	)

NIM HTTP 设置最低传输速度

Parameters

[in]	request_handle	http任务句柄
[in]	low_speed_limit	最低传输的字节数(大于0)
[in]	low_speed_time	多少秒传输速度不得低于low_speed_limit，不满足条件则会终止传输(大于0)

Returns: void 无返回值

◆ nim_http_set_proxy()

void nim_http_set_proxy	(	HttpRequestHandle	request_handle,
		int	type,
		const char *	host,
		short	port,
		const char *	user,
		const char *	pass
	)

NIM HTTP 设置代理

Parameters

[in]	request_handle	http任务句柄
[in]	type	代理类型NIMProxyType
[in]	host	代理地址
[in]	port	代理端口
[in]	user	代理账号
[in]	pass	代理密码

Returns: void 无返回值

◆ nim_http_set_request_method_as_post()

void nim_http_set_request_method_as_post ( HttpRequestHandle request_handle )

NIM HTTP 强制设置http请求方法为post

Parameters

[in] request_handle http任务句柄

Returns: void 无返回值

◆ nim_http_set_request_progress_cb()

void nim_http_set_request_progress_cb	(	HttpRequestHandle	request_handle,
		nim_http_request_progress_cb	progress_callback,
		const void *	user_data
	)

NIM HTTP 设置进度回调

Parameters

[in]	request_handle	http任务句柄
[in]	progress_callback	进度回调函数
[in]	user_data	自定义数据

Returns: void 无返回值

◆ nim_http_set_request_speed_cb()

void nim_http_set_request_speed_cb	(	HttpRequestHandle	request_handle,
		nim_http_request_speed_cb	speed_callback,
		const void *	user_data
	)

NIM HTTP 设置实时速度回调

Parameters

[in]	request_handle	http任务句柄
[in]	speed_callback	速度回调函数
[in]	user_data	自定义数据

Returns: void 无返回值

◆ nim_http_set_request_transfer_cb()

void nim_http_set_request_transfer_cb	(	HttpRequestHandle	request_handle,
		nim_http_request_transfer_cb	transfer_callback,
		const void *	user_data
	)

NIM HTTP 设置传输信息回调

Parameters

[in]	request_handle	http任务句柄
[in]	transfer_callback	结束回调，获取实际传输信息
[in]	user_data	自定义数据

Returns: void 无返回值

◆ nim_http_set_timeout()

void nim_http_set_timeout	(	HttpRequestHandle	request_handle,
		int	timeout_ms
	)

NIM HTTP 设置超时

Parameters

[in]	request_handle	http任务句柄
[in]	timeout_ms	超时时间，单位是毫秒

Returns: void 无返回值

◆ nim_http_uninit()

void nim_http_uninit ( )

NIM HTTP 反初始化

Returns: void 无返回值

Functions

Detailed Description

Function Documentation

◆ nim_http_add_request_header()

◆ nim_http_create_download_file_range_request()

◆ nim_http_create_download_file_request()

◆ nim_http_create_request()

◆ nim_http_get_response_head()

◆ nim_http_init()

◆ nim_http_init_log()

◆ nim_http_is_init_log()

◆ nim_http_post_request()

◆ nim_http_remove_request()

◆ nim_http_set_low_speed()

◆ nim_http_set_proxy()

◆ nim_http_set_request_method_as_post()

◆ nim_http_set_request_progress_cb()

◆ nim_http_set_request_speed_cb()

◆ nim_http_set_request_transfer_cb()

◆ nim_http_set_timeout()

◆ nim_http_uninit()