Class Index | File Index

Classes


Class IYYNet


Extends IYYCommon.
网络通讯接口。提供广播数据和接收广播数据的功能。
Defined in: yyapi.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
IYYNet()
IYYNet 构造函数。
Field Summary
Field Attributes Field Name and Description
<static>  
IYYNet.CLOSED
收到网络断开事件。点击关闭应用按钮的时候会触发,收到此消息2秒后,应用会被关闭。
<static>  
IYYNet.RECV
收到频道广播消息事件。 收到广播消息后触发此事件。
Method Summary
Method Attributes Method Name and Description
 
全频道数据广播,包括自己。两次广播需要间隔20毫秒,否则广播数据可能会丢失。
 
broadcastSubChannel(sub_channel_id, data)
子频道数据广播,包括自己。两次广播需要间隔20毫秒,否则广播数据可能会丢失。
 
broadcastToUsers(u_array, data)
广播给指定用户。两次广播需要间隔20毫秒,否则广播数据可能会丢失。
Methods borrowed from class IYYCommon:
addEventListener, removeEventListener
Class Detail
IYYNet()
IYYNet 构造函数。
Field Detail
<static> IYYNet.CLOSED
收到网络断开事件。点击关闭应用按钮的时候会触发,收到此消息2秒后,应用会被关闭。
侦听函数格式: function(eventData){    } 
eventData.result: Number类型  基于何种原因断开了连接,请参考错误代码。result=983064时表示点击了关闭应用按钮,即将断开连接;
使用示例:
yy.net.addEventListener(IYYNet.CLOSED,onClosed);

function onClosed(eventData)
{
    document.getElementById("txtLog").innerHTML="关闭原因:"+eventData.result;
}

<static> IYYNet.RECV
收到频道广播消息事件。 收到广播消息后触发此事件。
侦听函数格式: function(eventData){    } 
eventData.data: String类型  接收到的数据。
使用示例:
yy.net.addEventListener(IYYNet.RECV,onRecv);

function onRecv(eventData)
{
    document.getElementById("txtLog").innerHTML="接收到"+eventData.data;
}
Method Detail
{Object} broadcastAllChannel(data)
全频道数据广播,包括自己。两次广播需要间隔20毫秒,否则广播数据可能会丢失。
Parameters:
{String} data
要广播的数据。最大长度2048个字节。
Returns:
返回调用是否成功,具体属性如下。
ret: Number类型 返回码 0=成功,非0值失败,具体请参考错误代码。

{Object} broadcastSubChannel(sub_channel_id, data)
子频道数据广播,包括自己。两次广播需要间隔20毫秒,否则广播数据可能会丢失。
Parameters:
{Number} sub_channel_id
子频道的长位id。
{String} data
要广播的数据,最大长度2048个字节。
Returns:
返回调用是否成功,具体属性如下。
ret: Number类型 返回码 0=成功,非0值失败,具体请参考错误代码。

{Object} broadcastToUsers(u_array, data)
广播给指定用户。两次广播需要间隔20毫秒,否则广播数据可能会丢失。
Parameters:
{Array} u_array
接收广播的用户uid,保存在一个数组中,用户个数必须小于等于100。
{String} data
要广播的数据。最大长度2048个字节。
Returns:
返回调用是否成功,具体属性如下。
ret: Number类型 返回码 0=成功,非0值失败,具体请参考错误代码。

Documentation generated by JsDoc Toolkit 2.4.0