p2p sdk接口说明

冷不防 2024-03-27 14:09 73阅读 0赞

深圳市好游科技有限公司开发的p2p sdk(HYP2P)，支持linux、安卓、IOS和windows等常见平台,支持c语言，c++,c\#,java,unity等环境下使用，仅提供了几个简单接口，您只要掌握了这几个简单接口便可以通过这个p2p中间件完成业务通信功能。http、rtmp或rtsp等由tcp或udp开发的应用均能接入。

HYP2P SDK支持以下特性：

1、支持双对称型nat打洞,成功率极高。

2、支持app与设备之间一对一、多对一的p2p连接。

3、中转模式支持一路上传，多个客户端查看，节省宽带。

先熟悉两个基本概念，后续的接口几乎都是用它们作为参数：

**session(会话) ：**一个由p2p双方建立起来的会话，如一个app连接一个设备称作一个session

如果一个app同时连接多个设备，就同时存在多个session，当一个session建立后，支持多通道，双向收发数据

**channel(通道) ：**当一个p2p连接建立起来后，这个session就存在多个channel，用户可自行定义每个channel的作用，也可以只使用其中的一个通道。

下面是详细的接口说明

1、p2p\_engine\_init

<table style=""> 
 <tbody> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数声明：</td> 
 <td style="width:707px;vertical-align:top;height:52px;">int p2p_engine_init (const char* login_domain,int login_port, const char* logfile)</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数作用</td> 
 <td style="width:707px;vertical-align:top;height:52px;">初始化p2p sdk</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">返回值</td> 
 <td style="width:707px;vertical-align:top;height:52px;">成功则返回0，失败返回小于0的错误码</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">参数定义</td> 
 <td style="width:707px;vertical-align:top;height:52px;">描述</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">login_domain</td> 
 <td style="width:707px;vertical-align:top;height:52px;">p2p服务器域名或ip，不能为NULL</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">login_port</td> 
 <td style="width:707px;vertical-align:top;height:52px;">p2p服务器端口号</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">logfile</td> 
 <td style="width:707px;vertical-align:top;height:52px;">日志文件，可以为NULL或“”</td> 
 </tr> 
 </tbody> 
</table>

2、p2p\_engine\_destroy

<table style=""> 
 <tbody> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数声明：</td> 
 <td style="width:707px;vertical-align:top;height:52px;">void p2p_engine_destroy( )</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数作用</td> 
 <td style="width:707px;vertical-align:top;height:52px;">回收p2p&nbsp;sdk初始化时申请的相关资源</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">返回值</td> 
 <td style="width:707px;vertical-align:top;height:52px;">无</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">参数定义</td> 
 <td style="width:707px;vertical-align:top;height:52px;">无</td> 
 </tr> 
 </tbody> 
</table>

3、p2p\_get\_free\_session

<table style=""> 
 <tbody> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数声明：</td> 
 <td style="width:707px;vertical-align:top;height:52px;">int p2p_get_free_session()</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数作用</td> 
 <td style="width:707px;vertical-align:top;height:52px;">获取一个可用的会话，最多同时支持64个，默认从0开始返回第一个未使用的索引，并创建会话</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">返回值</td> 
 <td style="width:707px;vertical-align:top;height:52px;">成功则返回会话的索引(0到63)，后续接口都需要此值作为参数。失败返回小于0的错误码</td> 
 </tr> 
 </tbody> 
</table>

4、p2p\_close\_session

<table style=""> 
 <tbody> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数声明：</td> 
 <td style="width:707px;vertical-align:top;height:52px;">int p2p_close_session(int session)</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数作用</td> 
 <td style="width:707px;vertical-align:top;height:52px;">通信结束时，关闭指定的会话</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">返回值</td> 
 <td style="width:707px;vertical-align:top;height:52px;">成功则返回0，失败返回小于0的错误码</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">参数定义</td> 
 <td style="width:707px;vertical-align:top;height:52px;">描述</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">session</td> 
 <td style="width:707px;vertical-align:top;height:52px;">会话的索引，可以是p2p_get_free_session或p2p_create_session的返回值</td> 
 </tr> 
 </tbody> 
</table>

5、p2p\_set\_sink

<table style=""> 
 <tbody> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数声明：</td> 
 <td style="width:707px;vertical-align:top;height:52px;">int p2p_set_sink(int session, struct&nbsp;IP2PSessionSink* sink)</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数作用</td> 
 <td style="width:707px;vertical-align:top;height:52px;">设置会话的回调接口，当会话的状态发生变化，或者会话收到数据时会调用回调函数</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">返回值</td> 
 <td style="width:707px;vertical-align:top;height:52px;">成功则返回0，失败返回小于0的错误码</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">参数定义</td> 
 <td style="width:707px;vertical-align:top;height:52px;">描述</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">session</td> 
 <td style="width:707px;vertical-align:top;height:52px;">会话的索引，可以是p2p_get_free_session或p2p_create_session的返回值</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">sink</td> 
 <td style="width:707px;vertical-align:top;height:52px;">回调的接口结构体指针</td> 
 </tr> 
 </tbody> 
</table>

6、p2p\_connect\_server

<table style=""> 
 <tbody> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数声明：</td> 
 <td style="width:707px;vertical-align:top;height:52px;">int p2p_connect_server(int session, int64_t myuid,const char *secret);</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:72px;">函数作用</td> 
 <td style="width:707px;vertical-align:top;height:72px;">连接p2p服务器，但不发送登入消息到服务器。连接成功后，再调用p2p_login_server发送登入消息。这个函数是异步操作，连接成功后通过IP2PSessionSink.onServerConnected接收到通知。</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">返回值</td> 
 <td style="width:707px;vertical-align:top;height:52px;">成功则返回0，失败返回小于0的错误码</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">参数定义</td> 
 <td style="width:707px;vertical-align:top;height:52px;">描述</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">session</td> 
 <td style="width:707px;vertical-align:top;height:52px;">会话的索引，可以是p2p_get_free_session或p2p_create_session的返回值</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">myuid</td> 
 <td style="width:707px;vertical-align:top;height:52px;">由&nbsp;好游科技有限公司&nbsp;生成的设备授权id，只有允许被动接收p2p连接的设备才需要传入有效的值。非被动接收连接的设备，如：手机端的app，传入0既可以。</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">secret</td> 
 <td style="width:707px;vertical-align:top;height:52px;">由 好游科技有限公司 生成的设备授权密钥，只有允许被动接收p2p连接的设备才需要传入有效的值。非被动接收连接的设备，如：手机端的app，传入NULL或空字符串""都可以。</td> 
 </tr> 
 </tbody> 
</table>

7、p2p\_login\_server

<table style=""> 
 <tbody> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数声明：</td> 
 <td style="width:707px;vertical-align:top;height:52px;">int p2p_login_server(int session, int64_t uid);</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:72px;">函数作用</td> 
 <td style="width:707px;vertical-align:top;height:72px;">发送登入消息到p2p服务器，通常都是在IP2PSessionSink.onServerConnected回调函数中调用。</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">返回值</td> 
 <td style="width:707px;vertical-align:top;height:52px;">成功则返回0，失败返回小于0的错误码</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">参数定义</td> 
 <td style="width:707px;vertical-align:top;height:52px;">描述</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">session</td> 
 <td style="width:707px;vertical-align:top;height:52px;">会话的索引，可以是p2p_get_free_session或p2p_create_session的返回值</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">uid</td> 
 <td style="width:707px;vertical-align:top;height:52px;">唯一标识设备的id，比如摄像头的id。此id在p2p_connect_peer时用来匹配设备。此id由用户应用自己维护，一般使用手机app上从服务器收到的数据库的设备id作为此参数与上一接口中设备授权id不同。</td> 
 </tr> 
 </tbody> 
</table>

8、p2p\_connect\_peer

<table style=""> 
 <tbody> 
 <tr> 
 <td style="width:168px;vertical-align:top;height:52px;">函数声明：</td> 
 <td style="width:707px;vertical-align:top;height:52px;">int p2p_connect_peer(int session, int64_t peerid, int nForceReconnect);</td> 
 </tr> 
 <tr> 
 <td style="width:168px;vertical-align:top;height:72px;">函数作用</td> 
 <td style="width:707px;vertical-align:top;height:72px;">尝试与设备peerid 建立p2p连接。必须收到IP2PSessionSink.onLoginServer回调函数的通知之后再调用此接口。要成功与设备建立p2p连接，需要满足两个条件： 
 <ol> 
 <li style="margin-left:1.4em;list-style-type:decimal;text-indent:0;">设备已经登入p2p服务器</li> 
 </ol> 
 <ol> 
 <li style="margin-left:1.4em;list-style-type:decimal;text-indent:0;">自身已经登入p2p服务器</li> 
 </ol></td> 
 </tr> 
 <tr> 
 <td style="width:168px;vertical-align:top;height:52px;">返回值</td> 
 <td style="width:707px;vertical-align:top;height:52px;">成功则返回0，失败返回小于0的错误码</td> 
 </tr> 
 <tr> 
 <td style="width:168px;vertical-align:top;height:52px;">参数定义</td> 
 <td style="width:707px;vertical-align:top;height:52px;">描述</td> 
 </tr> 
 <tr> 
 <td style="width:168px;vertical-align:top;height:52px;">session</td> 
 <td style="width:707px;vertical-align:top;height:52px;">会话的索引，可以是p2p_get_free_session或p2p_create_session的返回值</td> 
 </tr> 
 <tr> 
 <td style="width:168px;vertical-align:top;height:77px;">peerid</td> 
 <td style="width:707px;vertical-align:top;height:77px;">唯一标识设备的id，比如摄像头的id。此id在设备调用p2p_login_server时由传入。此id由用户应用自己维护，一般使用数据库的设备id作为此参数</td> 
 </tr> 
 <tr> 
 <td style="width:168px;vertical-align:top;height:77px;">nForceReconnect</td> 
 <td style="width:707px;vertical-align:top;height:77px;">打洞成功后，短时间内又调用p2p_connect_peer，p2p底层会立即返回成功，不会重新去申请打洞，除非检测到打洞状态已经断开了。这个参数设置成1，会使p2p底层重新打洞。</td> 
 </tr> 
 </tbody> 
</table>

9、p2p\_start\_proxy

<table style=""> 
 <tbody> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数声明：</td> 
 <td style="width:707px;vertical-align:top;height:52px;">int p2p_start_proxy(int session, int port,int isApp)</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:72px;">函数作用</td> 
 <td style="width:707px;vertical-align:top;height:72px;">当p2p连接建立后，原本用户的应用访问的所有服务器数据，都将从本机的port端口获得。比如原来从&nbsp;<a style="color:#0A6CFF;" href="https://haoyou456.com:80" rel="nofollow">haoyou456.com:80</a>&nbsp;获取数据，现在变成从127.0.0.1:port获得。此函数是异步的，成功后IP2PSessionSink.onProxyStarted回调函数将被调用</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">返回值</td> 
 <td style="width:707px;vertical-align:top;height:52px;">成功则返回0，失败返回小于0的错误码</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">参数定义</td> 
 <td style="width:707px;vertical-align:top;height:52px;">描述</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">session</td> 
 <td style="width:707px;vertical-align:top;height:52px;">会话的索引，可以是p2p_get_free_session或p2p_create_session的返回值</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">port</td> 
 <td style="width:707px;vertical-align:top;height:52px;">本地socket端口号，如果传入0则会自动生成。</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">isApp</td> 
 <td style="width:707px;vertical-align:top;height:52px;">此参数用来标识双向通信中是设备端还是手机app端比如双向语音对讲或双向视频通话时，标识设备端或手机app端</td> 
 </tr> 
 </tbody> 
</table>

10、p2p\_stop\_proxy

<table style=""> 
 <tbody> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数声明：</td> 
 <td style="width:707px;vertical-align:top;height:52px;">int p2p_stop_proxy(int session)</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数作用</td> 
 <td style="width:707px;vertical-align:top;height:52px;">停止数据传输，通信结束时由用户调用</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">返回值</td> 
 <td style="width:707px;vertical-align:top;height:52px;">成功则返回0，失败返回小于0的错误码</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">参数定义</td> 
 <td style="width:707px;vertical-align:top;height:52px;">描述</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">session</td> 
 <td style="width:707px;vertical-align:top;height:52px;">会话的索引，可以是p2p_get_free_session或p2p_create_session的返回值</td> 
 </tr> 
 </tbody> 
</table>

11、p2p\_set\_device\_port

<table style=""> 
 <tbody> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数声明：</td> 
 <td style="width:707px;vertical-align:top;height:52px;">int p2p_set_device_port(int session, int port)</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:72px;">函数作用</td> 
 <td style="width:707px;vertical-align:top;height:72px;">由设备端调用，指定视频或语音服务器的端口号，比如：rtsp或rtmp推流服务器的端口号p2p连接建立后，用户app需要的所有数据，将从此端口获取</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">返回值</td> 
 <td style="width:707px;vertical-align:top;height:52px;">成功则返回0，失败返回小于0的错误码</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">参数定义</td> 
 <td style="width:707px;vertical-align:top;height:52px;">描述</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">session</td> 
 <td style="width:707px;vertical-align:top;height:52px;">会话的索引，可以是p2p_get_free_session或p2p_create_session的返回值</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">port</td> 
 <td style="width:707px;vertical-align:top;height:52px;">视频或语音服务器的端口号，比如：rtsp或rtmp推流服务器的端口号</td> 
 </tr> 
 </tbody> 
</table>

12、p2p\_send (如果不使用sockcet，可以改成用此函数发送数据)

<table style=""> 
 <tbody> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数声明：</td> 
 <td style="width:707px;vertical-align:top;height:52px;">int p2p_send(int session, int64_t uid, int channel, const void* buff, unsigned int len,unsigned int blockid=0)</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:72px;">函数作用</td> 
 <td style="width:707px;vertical-align:top;height:72px;">p2p连接建立后，可以调用此函数发送数据也可以不用此函数，无需对原来使用socket的应用进行修改。接收端将从IP2PSessionSink.onRecvP2PData回调函数中接收到数据</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">返回值</td> 
 <td style="width:707px;vertical-align:top;height:52px;">成功则返回发送的字节数，失败返回小于0的错误码</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">参数定义</td> 
 <td style="width:707px;vertical-align:top;height:52px;">描述</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">session</td> 
 <td style="width:707px;vertical-align:top;height:52px;">会话的索引，可以是p2p_get_free_session或p2p_create_session的返回值</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:66px;">uid</td> 
 <td style="width:707px;vertical-align:top;height:66px;">onHoleState或onChannelState函数的第二个参数服务器维护的一个双方会话的ID，与不同的设备之间建立的p2p会话， 此id会不同</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:66px;">channel</td> 
 <td style="width:707px;vertical-align:top;height:66px;">用户app自己设置，取值范围从0 — 100</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:66px;">buff</td> 
 <td style="width:707px;vertical-align:top;height:66px;">指向要发送的数据的地址</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:66px;">len</td> 
 <td style="width:707px;vertical-align:top;height:66px;">要发送的数据的长度</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:66px;">blockid</td> 
 <td style="width:707px;vertical-align:top;height:66px;">blockid默认填0</td> 
 </tr> 
 </tbody> 
</table>

13、p2p\_get\_state

<table style=""> 
 <tbody> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数声明：</td> 
 <td style="width:707px;vertical-align:top;height:52px;">int p2p_get_state(int session,int64_t uid)</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数作用</td> 
 <td style="width:707px;vertical-align:top;height:52px;">获取p2p会话的连接状态</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">返回值</td> 
 <td style="width:707px;vertical-align:top;height:52px;">0&nbsp;&nbsp;p2p连接未建立1&nbsp;&nbsp;p2p连接已建立2 p2p连接已建立，直接内网互连3&nbsp;&nbsp;中转模式</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">参数定义</td> 
 <td style="width:707px;vertical-align:top;height:52px;">描述</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">session</td> 
 <td style="width:707px;vertical-align:top;height:52px;">会话的索引，可以是p2p_get_free_session或p2p_create_session的返回值</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:66px;">uid</td> 
 <td style="width:707px;vertical-align:top;height:66px;">onHoleState或onChannelState函数的第二个参数服务器维护的一个双方会话的ID，与不同的设备之间建立的p2p会话， 此id会不同</td> 
 </tr> 
 </tbody> 
</table>

14、p2p\_set\_log\_level

<table style=""> 
 <tbody> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数声明：</td> 
 <td style="width:707px;vertical-align:top;height:52px;">int p2p_set_log_level(int level)</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数作用</td> 
 <td style="width:707px;vertical-align:top;height:52px;">获取p2psdk底层的日志等级</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">返回值</td> 
 <td style="width:707px;vertical-align:top;height:52px;">无</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">参数定义</td> 
 <td style="width:707px;vertical-align:top;height:52px;">描述</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">level</td> 
 <td style="width:707px;vertical-align:top;height:52px;">日志等级，&nbsp;取值0-3，越大日志越详细</td> 
 </tr> 
 </tbody> 
</table>

**以下接口用于获取统计信息**

1、p2p\_get\_recv\_kbps

<table style=""> 
 <tbody> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数声明：</td> 
 <td style="width:707px;vertical-align:top;height:52px;">int p2p_get_recv_kbps(int session,int64_t clientid)</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数作用</td> 
 <td style="width:707px;vertical-align:top;height:52px;">获取p2psdk底层与某个设备的通讯数据接收速率</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">返回值</td> 
 <td style="width:707px;vertical-align:top;height:52px;">数据接收速率，比如：&nbsp;100kb/s</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">参数定义</td> 
 <td style="width:707px;vertical-align:top;height:52px;">描述</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">session</td> 
 <td style="width:707px;vertical-align:top;height:52px;">会话的索引，可以是p2p_get_free_session或p2p_create_session的返回值</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:66px;">uid</td> 
 <td style="width:707px;vertical-align:top;height:66px;">onHoleState或onChannelState函数的第二个参数服务器维护的一个双方会话的ID，与不同的设备之间建立的p2p会话， 此id会不同</td> 
 </tr> 
 </tbody> 
</table>

2、p2p\_get\_send\_kbps

<table style=""> 
 <tbody> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数声明：</td> 
 <td style="width:707px;vertical-align:top;height:52px;">int p2p_get_send_kbps(int session,int64_t clientid)</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数作用</td> 
 <td style="width:707px;vertical-align:top;height:52px;">获取p2psdk底层与某个设备的通讯数据时的发送速率</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">返回值</td> 
 <td style="width:707px;vertical-align:top;height:52px;">数据发送速率，比如： 100kb/s</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">参数定义</td> 
 <td style="width:707px;vertical-align:top;height:52px;">描述</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">session</td> 
 <td style="width:707px;vertical-align:top;height:52px;">会话的索引，可以是p2p_get_free_session或p2p_create_session的返回值</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:66px;">uid</td> 
 <td style="width:707px;vertical-align:top;height:66px;">onHoleState或onChannelState函数的第二个参数服务器维护的一个双方会话的ID，与不同的设备之间建立的p2p会话， 此id会不同</td> 
 </tr> 
 </tbody> 
</table>

3、p2p\_get\_frame\_rate

<table style=""> 
 <tbody> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数声明：</td> 
 <td style="width:707px;vertical-align:top;height:52px;">int p2p_get_frame_rate()</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数作用</td> 
 <td style="width:707px;vertical-align:top;height:52px;">获取p2psdk底层线程的每秒帧率</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">返回值</td> 
 <td style="width:707px;vertical-align:top;height:52px;">p2psdk底层线程的每秒帧率，比如&nbsp;90帧/秒</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">参数定义</td> 
 <td style="width:707px;vertical-align:top;height:52px;">无</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;"></td> 
 <td style="width:707px;vertical-align:top;height:52px;"></td> 
 </tr> 
 </tbody> 
</table>

**以下接口极少使用，只有特殊需求时才会使用到**

1、p2p\_get\_localip

<table style=""> 
 <tbody> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数声明：</td> 
 <td style="width:707px;vertical-align:top;height:52px;">int p2p_get_localip(char* ip, int buflen)</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数作用</td> 
 <td style="width:707px;vertical-align:top;height:52px;">返回p2p底层获取到的本机ip</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">返回值</td> 
 <td style="width:707px;vertical-align:top;height:52px;">AF_INET或AF_INET6，不同的平台此值不一样</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">参数定义</td> 
 <td style="width:707px;vertical-align:top;height:52px;">描述</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">ip</td> 
 <td style="width:707px;vertical-align:top;height:52px;">获取到的ip内存存放地址</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">buflen</td> 
 <td style="width:707px;vertical-align:top;height:52px;">ip内存大小</td> 
 </tr> 
 </tbody> 
</table>

2、p2p\_set\_localip

<table style=""> 
 <tbody> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数声明：</td> 
 <td style="width:707px;vertical-align:top;height:52px;">void p2p_set_localip(char* ip)</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数作用</td> 
 <td style="width:707px;vertical-align:top;height:52px;">设置p2p底层使用的本机ip一般情况下不需要设置，只有获取失败或多ip的情况获取错误时，才需要设置</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">返回值</td> 
 <td style="width:707px;vertical-align:top;height:52px;">无</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">参数定义</td> 
 <td style="width:707px;vertical-align:top;height:52px;">描述</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">ip</td> 
 <td style="width:707px;vertical-align:top;height:52px;">ip地址字符串，比如“192.168.1.19”,不能是域名</td> 
 </tr> 
 </tbody> 
</table>

3、p2p\_set\_frame\_rate（此函数一般不需要调用）

<table style=""> 
 <tbody> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数声明：</td> 
 <td style="width:707px;vertical-align:top;height:52px;">void p2p_set_frame_rate(int num)</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数作用</td> 
 <td style="width:707px;vertical-align:top;height:52px;">设置p2psdk底层线程的每秒帧率。</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">返回值</td> 
 <td style="width:707px;vertical-align:top;height:52px;">无</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">参数定义</td> 
 <td style="width:707px;vertical-align:top;height:52px;">描述</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">num</td> 
 <td style="width:707px;vertical-align:top;height:52px;">设置p2psdk底层线程的每秒帧率，建议：90-500之间，如果太低了，可能会出现丢包现象。</td> 
 </tr> 
 </tbody> 
</table>

**IP2PSessionSink接口回调函数说明**

1、onServerConnected

<table style=""> 
 <tbody> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数声明：</td> 
 <td style="width:707px;vertical-align:top;height:52px;">void onServerConnected(int session, int state)</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数作用</td> 
 <td style="width:707px;vertical-align:top;height:52px;">已经连接上p2p服务器: 此时只是检测到p2p服务器可连接，未发送登入包</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">返回值</td> 
 <td style="width:707px;vertical-align:top;height:52px;">无</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">参数定义</td> 
 <td style="width:707px;vertical-align:top;height:52px;">描述</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">session</td> 
 <td style="width:707px;vertical-align:top;height:52px;">会话的索引，p2p_connect_server函数传入的第一个函数</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">state</td> 
 <td style="width:707px;vertical-align:top;height:52px;">0表示连接p2p服务器成功</td> 
 </tr> 
 </tbody> 
</table>

2、onLoginServer

<table style=""> 
 <tbody> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数声明：</td> 
 <td style="width:707px;vertical-align:top;height:52px;">void onLoginServer(int session, int state)</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数作用</td> 
 <td style="width:707px;vertical-align:top;height:52px;">已经登入上p2p服务器，后续可以根据peerid连接某个设备了</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">返回值</td> 
 <td style="width:707px;vertical-align:top;height:52px;">无</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">参数定义</td> 
 <td style="width:707px;vertical-align:top;height:52px;">描述</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">session</td> 
 <td style="width:707px;vertical-align:top;height:52px;">会话的索引，p2p_login_server函数传入的第一个函数</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">state</td> 
 <td style="width:707px;vertical-align:top;height:52px;">0表示登入p2p服务器成功</td> 
 </tr> 
 </tbody> 
</table>

3、onHoleState

<table style=""> 
 <tbody> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数声明：</td> 
 <td style="width:707px;vertical-align:top;height:52px;">void onHoleState(int session,int64_t uid, int state)</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数作用</td> 
 <td style="width:707px;vertical-align:top;height:52px;">底层p2p会话的状态发生变化</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">返回值</td> 
 <td style="width:707px;vertical-align:top;height:52px;">无</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">参数定义</td> 
 <td style="width:707px;vertical-align:top;height:52px;">描述</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:49px;">session</td> 
 <td style="width:707px;vertical-align:top;height:49px;">p2p会话的索引号</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">uid</td> 
 <td style="width:707px;vertical-align:top;height:52px;">服务器维护的一个双方会话的ID，与不同的设备之间建立的p2p会话，&nbsp;此uid会不同</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">state</td> 
 <td style="width:707px;vertical-align:top;height:52px;"> 0 p2p打洞失败，服务器中转建立失败或中转连接断开 1 p2p打洞成功，使用外网IP,后续可以创建通道或者直接收发udp数据 2 p2p打洞成功，使用内网IP,后续可以创建通道或者直接收发udp数据 3 p2p打洞失败，服务器中转已经建立</td> 
 </tr> 
 </tbody> 
</table>

4、onChannelState

<table style=""> 
 <tbody> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数声明：</td> 
 <td style="width:707px;vertical-align:top;height:52px;">void onChannelState(&nbsp;int session, int64_t uid, int channel, int state&nbsp;)</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数作用</td> 
 <td style="width:707px;vertical-align:top;height:52px;">p2p会话的通道状态发生变化</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">返回值</td> 
 <td style="width:707px;vertical-align:top;height:52px;">无</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">参数定义</td> 
 <td style="width:707px;vertical-align:top;height:52px;">描述</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">session</td> 
 <td style="width:707px;vertical-align:top;height:52px;">p2p会话的索引号</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">uid</td> 
 <td style="width:707px;vertical-align:top;height:52px;">服务器维护的一个双方会话的ID，与不同的设备之间建立的p2p会话， 此uid会不同</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">state</td> 
 <td style="width:707px;vertical-align:top;height:52px;">0:连接成功1:连接失败2:断开连接3:app用户主动关闭通道4:未连接的通道，udp使用</td> 
 </tr> 
 </tbody> 
</table>

5、onProxyStarted

<table style=""> 
 <tbody> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数声明：</td> 
 <td style="width:707px;vertical-align:top;height:52px;">void onProxyStarted(int session, int port)</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数作用</td> 
 <td style="width:707px;vertical-align:top;height:52px;">本地代理已经启动成功,tcp应用可以开始连接了</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">返回值</td> 
 <td style="width:707px;vertical-align:top;height:52px;">无</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">参数定义</td> 
 <td style="width:707px;vertical-align:top;height:52px;">描述</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">session</td> 
 <td style="width:707px;vertical-align:top;height:52px;">p2p会话的索引，p2p_start_proxy函数传入的第一个函数</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">port</td> 
 <td style="width:707px;vertical-align:top;height:52px;">port本地代理的端口号</td> 
 </tr> 
 </tbody> 
</table>

6、onRecvP2PData

<table style=""> 
 <tbody> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数声明：</td> 
 <td style="width:707px;vertical-align:top;height:52px;">void onRecvP2PData(int session,int64_t uid,&nbsp;int channel,const unsigned char * pDataBuffer, int wDataSize) </td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数作用</td> 
 <td style="width:707px;vertical-align:top;height:52px;">收到p2p对端发送过来的数据包</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">返回值</td> 
 <td style="width:707px;vertical-align:top;height:52px;">无</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">参数定义</td> 
 <td style="width:707px;vertical-align:top;height:52px;">描述</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">session</td> 
 <td style="width:707px;vertical-align:top;height:52px;">p2p会话的索引</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">uid</td> 
 <td style="width:707px;vertical-align:top;height:52px;">服务器维护的一个双方会话的ID，与不同的设备之间建立的p2p会话， 此uid会不同</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">channel</td> 
 <td style="width:707px;vertical-align:top;height:52px;"> p2p对端发送数据时指定的通道编号</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">pDataBuffer</td> 
 <td style="width:707px;vertical-align:top;height:52px;">接收到的数据内存地址</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">wDataSize</td> 
 <td style="width:707px;vertical-align:top;height:52px;">接收到的数据长度</td> 
 </tr> 
 </tbody> 
</table>

7、onRecvServerData

<table style=""> 
 <tbody> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数声明：</td> 
 <td style="width:707px;vertical-align:top;height:52px;">void onRecvServerData(int session, int64_t cmd, int subcmd, const unsigned char * pDataBuffer, int wDataSize) </td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数作用</td> 
 <td style="width:707px;vertical-align:top;height:52px;">由p2p底层使用，用户可忽略。</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">返回值</td> 
 <td style="width:707px;vertical-align:top;height:52px;">无</td> 
 </tr> 
 </tbody> 
</table>

8、onConnectPeerResult

<table style=""> 
 <tbody> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数声明：</td> 
 <td style="width:707px;vertical-align:top;height:52px;">int onConnectPeerResult(int session, int64_t deviceid, int state)</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">函数作用</td> 
 <td style="width:707px;vertical-align:top;height:52px;">连接对方或目标设备时，返回相应的状态。</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">返回值</td> 
 <td style="width:707px;vertical-align:top;height:52px;">无</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">参数定义</td> 
 <td style="width:707px;vertical-align:top;height:52px;">描述</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">session</td> 
 <td style="width:707px;vertical-align:top;height:52px;">p2p会话的索引</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">deviceid</td> 
 <td style="width:707px;vertical-align:top;height:52px;">连接对方的id或目标设备的id</td> 
 </tr> 
 <tr> 
 <td style="width:154px;vertical-align:top;height:52px;">state</td> 
 <td style="width:707px;vertical-align:top;height:52px;">0-成功，1-设备不存在，2-用户未登入,3-设备未连接，4-设备未授权</td> 
 </tr> 
 </tbody> 
</table>