1、kkp2p_engine_conf_t说明

云端部署的域名，即p2p_route模块的对外服务的域名。

商用版本仅支持域名。个人版本为调试方便同时支持ip地址。

如果仅使用局域网搜索功能，不部署云端服务，可以配置为NULL

云端部署的端口号，即p2p_route模块的对外服务的端口号

如果仅使用局域网搜索功能，不部署云端服务，可以配置为0

本地局域网广播端口号。如果需要使用局域网搜索功能，需要配置该端口号。

如果为0，则不能通过局域网搜索方式被搜索到。

max_log_size

如果是服务端，表示自己的peer id；如果是客户端，表示对端的peer id，最大长度为32个字节

通道类型

0：tcp通道类型，sdk解决udp包丢包、乱序以及流控

1：udp通道类型，sdk不解决udp包丢包、乱序以及流控

2：webrtc通道类型，支持浏览器webrtc观看设备端音视频

传输模式

1  p2p方式传输

2  中转方式传输

是否是一个加密的传输通道。

0 对应用层数据没有加解密

1  自动对业务数据进行加密或者解密

是否使用ipv6进行p2p通信。p2p通信支持使用ipv6

0 没有使用ipv6通信

1 使用ipv6进行p2p传输

用户自定义参数，由客户端建连时候在建连参数里面指定

fd

该通道的代理句柄。应用层通过对该fd进行读写数据就可以和对端通信。

需要注意的是，关闭通道并不会关闭该fd，该fd需要调用接口单独关闭，否则会有fd句柄泄漏。

创建连接的结果。

0 成功

<0 失败

channel

连接描述信息。

需要注意的是，应用层必须在该函数中将该channel的信息深度拷贝出来业务层自行保存，因为该函数中的channel是一个临时指针，该函数结束后便会自动释放。

应用层自行传入的参数

创建连接的结果。

>=0 成功

<0 失败

peerId

本端的登录账号

对端的sdp信息

对端的peer id，最大长度为32位

需要创建的通道类型

0：tcp通道类型，sdk解决udp包丢包、乱序以及流控

1：udp通道类型，sdk不解决udp包丢包、乱序以及流控

2：webrtc通道类型，仅支持从浏览器发起创建。

连接模式

0 自动模式，engine层会先创建一个p2p模式的连接，如果p2p模式失败（网络穿透失败）则连接使用中转模式

1  使用p2p模式，如果网络穿透失败，创建连接会失败，有一定的失败率。

2  使用中转模式，使用中转模式一般会创建连接成功

需要注意的是，如果在函数kkp2p_lan_search中使用，参数必须填1

encrypt_data

是否创建一个加密的连接。加密的密钥是双方通过算法自动协商而成的动态密钥。

0 不加密

1 加密

func

func_param

超时时间，当配置文件的login_domain为域名时候，为解析域名的超时时间。

如果传入的是域名，engine层会定时解析域名最新对应的ip地址列表；用于支持对云端p2p_route模块进行在线动态扩缩容。

void kkp2p_engine_destroy(kkp2p_engine_t* engine);

void kkp2p_switch_log_level(kkp2p_engine_t* engine, int level);

日志级别，定义如下：

0 不输出日志

1  error级别，仅输出error日志

2  normal级别，输出2及以下级别日志

3  info级别，输出3及以下级别日志

4 debug级别，输出所有日志

int kkp2p_get_domainip(kkp2p_engine_t* engine, char* szHosts, int ipLen, int ipCount)

获取kkp2p engine解析出来的ip地址列表，用于判断engine层域名解析的是否符合预期。engine会定时对域名进行解析，所以如果域名对应的ip地址发生了变化，需要再次调用kkp2p_get_domainip才能获取到engine层最新解析出来的域名对应的ip地址。

注意，szHosts指向的字符串数组的内存空间由应用层申请。比如char szHosts[10][16]是一个二维数组，表示总共有10个ip地址，每个ip地址占用16个字节的内存空间。用法参考如下,获取域名对应的最多10个ip地址

   char szHosts[10][16];

   memset(szHosts, 0, sizeof(szHosts);

   kkp2p_get_domainip(engine, szHosts, 16, 10);

小于0表示失败，一般是参数非法，比如ipLen参数小于16

大于等于0表示成功，即解析出来的实际ip地址个数，存放于szHosts二维数组中。

字符串数组。解析出来的ip地址会放入其中。

int kkp2p_join_net(kkp2p_engine_t* engine, char* peerId, char* secret);

将peer加入到云端p2p网络。如果peer想作为服务端（peer server）被客户端（peer client）通过云端主动发起建立连接，必须调用该接口。如果仅使用局域网搜索模式可以不掉用该接口。  

掉用该接口后，sdk的engine会将该peer登录到云端服务器，如果因为网络原因登录失败，会定时尝试直至成功。

该接口返回成功并不表示登录成功，登录过程由engine层的线程完成。

小于0表示失败

大于等于0表示成功

peer的id

int kkp2p_join_lan(kkp2p_engine_t* engine, char* peerId);

将peer加入到本地局域网。如果peer想作为服务端（peer server）被客户端（peer client）通过局域网搜索方式主动发起建立连接，必须调用该接口。如果不想使用局域网搜索功能可以不掉用该接口。

小于0表示失败

大于等于0表示成功

peer的id

int kkp2p_listen_fd(kkp2p_engine_t* engine);

获取engine层侦听连接相关联的fd句柄，该句柄可读时候，表示有连接过来，可以通过调用kkp2p_accept来获取一个新的远程连接。

应用层是否必须掉用该接口，取决于您的编程模型。如果有单独的业务线程来掉用kkp2p_accept接口，可以不需要调用该接口。

小于等于0表示失败

大于0表示成功

int kkp2p_accept(kkp2p_engine_t* engine，int timeout, kkp2p_channel_t* channel);

获取一个远程连接

小于0表示失败

等于0表示超时

大于0表示成功

int kkp2p_connect(kkp2p_engine_t* engine, kkp2p_connect_ctx_t* ctx, kkp2p_channel_t* channel);

通过云端搜索方式，和对端创建一个连接，即创建一个传输通道。

如果ctx参数的func为NULL，该接口是一个同步函数，创建连接结束后返回。

如果ctx参数的func不为NULL，该接口是一个异步函数，会立即返回，engine层在创建连接结束后调用func函数通知业务层，func函数由业务层自定义实现。

小于0表示失败

大于等于0表示成功

int kkp2p_lan_search(kkp2p_engine_t* engine, kkp2p_connect_ctx_t* ctx, kkp2p_channel_t* channel);

通过局域网搜索方式，对端创建一个连接，即创建一个传输通道。

参数含义和kkp2p_connect相同。

需要注意是的，局域网搜索模式时候，ctx的connect_mode字段必须填1，否则会返回参数错误

小于0表示失败

大于等于0表示成功

int kkp2p_read(int fd, char* buff, int len, int timeout);

读取对端发过来的数据。

需要说明的是，fd本身就是一个socket句柄，您也可以通过自己实现的函数或者操作系统提供的函数对其进行读取操作，以支持更大的编程灵活性。

kkp2p_read是kkp2p sdk提供的一个读取实现。

小于0表示失败，此时应用层应该关闭fd句柄

等于0表示超时

大于0表示实际读到的字节数

int kkp2p_write(int fd, char* buff, int len, int timeout);

向对端发送的数据。

需要说明的是，fd本身就是一个socket句柄，您也可以通过自己实现的函数或者操作系统提供的函数对其进行写入操作，以支持更大的编程灵活性。

kkp2p_write是kkp2p sdk提供的一个写入实现。

小于0表示失败，此时应用层应该关闭fd句柄

等于0表示超时

大于0表示实际写入成功的字节数，对于未写入成功的字节数，应用层应该再次尝试写入未成功的数据。

void kkp2p_close_channel(kkp2p_engine_t* engine, uint32_t channel);

关闭连接。应用层调用该接口后，engine层会等到该连接所有的数据都发送出去后在真正删除该连接，不过最多只会等待3分钟。

需要注意的是，关闭连接，并不会关闭该连接的代理fd，该代理fd的关闭，需要通过kkp2p_close_fd另行关闭。

之所以连接的fd由应用层自行管理，是为了更大的编程灵活性。

需要提醒您注意，对于连接的fd句柄，应用层最多只能调用一次关闭接口，否则可能会有一些问题。因为对于有些系统，socket的fd句柄是可以重复使用的，比如某个fd的值被关闭后，重新创建一个新的socket句柄，会复用该值。

无

void kkp2p_close_fd(int fd);

关闭连接对应的代理句柄。之所以连接的fd由应用层自行关闭，是为了更大的编程灵活性。当您读写fd句柄异常时候，需要调用该接口关闭fd句柄。

需要提醒您注意，对于连接的fd句柄，应用层最多只能调用一次关闭接口，否则可能会有一些问题。因为对于有些系统，socket的fd句柄是可以重复使用的，比如某个fd的值被关闭后，重新创建一个新的socket句柄，会复用该值。

无

int kkp2p_start_proxy(kkp2p_engine_t* engine, char* ip, uint16_t port, kkp2p_connect_ctx_t* ctx, uint32_t* proxyId);

该函数会创建一个p2p通信的代理，应用层将数据发送到参数中ip和port后，内部的p2p代理会自动将数据转发到ctx参数里面的账号。支持向外提供tcp地址代理和udp地址的代理。

>=0 成功

<0 失败

void kkp2p_stop_proxy(kkp2p_engine_t* engine, uint32_t proxyId);

停止p2p代理服务

无

设置回调函数，该回调函数由应用层完成，根据对端的sdp信息，设置好本端的sdp信息

无

设置本端dtls通信证书的指纹信息

无