XRADIO noPoll开发者指南

zaqwsx2

1、模块概要
1.1 功能介绍
noPoll 是一个 WebSocket 的开源实现，使用 ANSI C 编写，可用于构建纯 WebSocket 解决方案和为已有的 面向 TCP 的应用程序提供 WebSocket 支持。 noPoll 支持 WebSocket(ws://)和 TLS WebSocket(wss://)，从而允许基于消息的（通知处理程序）编程或面向流 的访问。 noPoll 相对于其他 WebSocket 实现（比如 libwebsocket），具有更快的速度和更小内存占用的优点。

1.2 代码位置

模块	文件类型	位置
noPoll	source	sdk/src/net/nopoll
	header	sdk/include/net/nopoll/
	demo	sdk/project/common/cmd/cmd_nopoll.c
		sdk/p roj ect/exa mple/websocket

2、noPoll接口
noPoll 即可以作为客户端模式，又客户作为服务器模式，大多数情况下都是作为客户端模式，服务器模式几 乎不用，故本文只描述客户端模式下的接口。
2.1 客户端接口
由于 noPoll 接口太多，很多接口都是用不到的，故本文列举了一些常用的接口。
2.1.1 context 操作接口

noPollCtx* nopoll_ctx_new(void)
功能	创建一个空的noPoll上下文。
参数	void
返回值	noPoll上下文指针
nopoll_bool nopoll_ctx_ref (noPollCtx * ctx)
功能	获取对所提供上下文的引用。
参数	Ctx：要获取引用的上下文。
返回值	0：失败，1：成功
void nopoll_ctx_unref (noPollCtx * ctx)
功能	释放对提供上下文的引用。 该函数和nopoll_ctx_ref对应使用，该函数还起到free资源的功能，当一个资源的引用为。时， noPoll会自动释放该资源。noPoll不存在nopoll_ctx_free接口，故需要用该接口释放。
参数	ctx：要释放引用的上下文。
返回值	void

2.1.3 连接操作接口

noPollCtx *nopoll_conn_ctx(noPollConn *conn)
功能	获取某个连接的noPoll上下文
参数	conn：返回其上下文的连接
返回值	连接的上下文
const char* nopoll_conn_get_accepted_protocol(noPollConn *conn )
功能	获取连接所支持的协议
参数	conn：要操作的连接
返回值	支持的协议，如果在握手期间或者握手未完成，则返回NULL
const char* nopoll_conn_get_close_reason(noPollConn *conn)
功能	获取连接关闭的原因
参数	conn：要操作的连接
返回值	远程服务器报告的原因，关闭原因；如果未报告，则为NULL。
int nopoll_conn_get_close_status(noPollConn *conn)
功能	获取连接关闭的状态码
参数	conn：要操作的连接
返回值	远程服务器报告的状态码，关闭原因；0： conn指针为NULL, 1005：关闭帧，1006：无关闭帧
const char* nopoll_conn_get_cookie(noPollConn *conn)
功能	获取握手期间接收到的Cookie标头内容（如果已收到）
参数	conn：要操作的连接
返回值	cookie指针，如果未收到则为NULL

更多详细内容请下载附件查看

游客，如果您要查看本帖隐藏内容请回复

lwxays

谢谢资料

jiangsirnj

谢谢分享

ericenter

更多详细内容请下载附件查看

清晖

:):):):)谢谢资料

Jolly_De82y

xuexixuexixuexixuex