dragonbones-runtime
Version:
the tools to build dragonbones file for diffrent framework
440 lines (439 loc) • 14.2 kB
TypeScript
declare namespace egret {
/**
* @private
* @version Egret 2.4
* @platform Web,Native
* @language en_US
*/
/**
* @private
* @version Egret 2.4
* @platform Web,Native
* @language zh_CN
*/
interface ISocket {
/**
* 连接
* @method egret.ISocket#connect
* @version Egret 2.4
* @platform Web,Native
* @language en_US
*/
/**
* 连接
* @method egret.ISocket#connect
* @version Egret 2.4
* @platform Web,Native
* @language zh_CN
*/
connect(host: string, port: number): void;
/**
* 连接
* @method egret.ISocket#connect
*/
connectByUrl(url: string): void;
/**
*
* @param onConnect
* @param onClose
* @param onSocketData
* @param onError
* @param thisObject
* @version Egret 2.4
* @platform Web,Native
* @language en_US
*/
/**
*
* @param onConnect
* @param onClose
* @param onSocketData
* @param onError
* @param thisObject
* @version Egret 2.4
* @platform Web,Native
* @language zh_CN
*/
addCallBacks(onConnect: Function, onClose: Function, onSocketData: Function, onError: Function, thisObject: any): void;
/**
*
* @param message
* @version Egret 2.4
* @platform Web,Native
* @language en_US
*/
/**
*
* @param message
* @version Egret 2.4
* @platform Web,Native
* @language zh_CN
*/
send(message: any): void;
/**
*
* @version Egret 2.4
* @platform Web,Native
* @language en_US
*/
/**
*
* @version Egret 2.4
* @platform Web,Native
* @language zh_CN
*/
close(): void;
/**
*
* @version Egret 4.1.0
* @platform Web,Native
* @language en_US
*/
/**
*
* @version Egret 4.1.0
* @platform Web,Native
* @language zh_CN
*/
disconnect(): void;
}
/**
* @version Egret 2.4
* @platform Web,Native
* @language en_US
*/
/**
* @version Egret 2.4
* @platform Web,Native
* @language zh_CN
*/
let ISocket: {
new (): ISocket;
};
}
declare namespace egret {
/**
* The egret.WebSocket class enables code to establish a TCP socket connection, for sending and receiving character string or binary data.
* To use the methods of the egret.WebSocket class, first use the constructor function new egret.WebSocket to create an egret.WebSocket object.
* The socket transmits and receives data in asynchronous mode.
* @event egret.Event.CONNECT Successfully connect to the server。
* @event egret.ProgressEvent.SOCKET_DATA Receiving server data。
* @event egret.Event.CLOSE Dispatched when the server closes the connection.
* @event egret.ProgressEvent Dispatched when an IO error causes a send or load operation to fail.
* @see http://edn.egret.com/cn/docs/page/602 WebSocket
* @version Egret 2.4
* @platform Web,Native
* @includeExample extension/socket/WebSocket.ts
* @language en_US
*/
/**
* egret.WebSocket 类启用代码以建立传输控制协议 (TCP) 套接字连接,用于发送和接收字符串或二进制数据。
* 要使用 egret.WebSocket 类的方法,请先使用构造函数 new egret.WebSocket 创建一个 egret.WebSocket 对象。
* 套接字以异步方式传输和接收数据。
* @event egret.Event.CONNECT 连接服务器成功。
* @event egret.ProgressEvent.SOCKET_DATA 接收服务器数据。
* @event egret.Event.CLOSE 在服务器关闭连接时调度。
* @event egret.IOErrorEvent.IO_ERROR 在出现输入/输出错误并导致发送或加载操作失败时调度。。
* @see http://edn.egret.com/cn/docs/page/602 WebSocket
* @version Egret 2.4
* @platform Web,Native
* @includeExample extension/socket/WebSocket.ts
* @language zh_CN
*/
class WebSocket extends egret.EventDispatcher {
/**
* Send and receive data in character string format
* @version Egret 2.4
* @platform Web,Native
* @language en_US
*/
/**
* 以字符串格式发送和接收数据
* @version Egret 2.4
* @platform Web,Native
* @language zh_CN
*/
static TYPE_STRING: string;
/**
* Send and receive data in binary format
* @version Egret 2.4
* @platform Web,Native
* @language en_US
*/
/**
* 以二进制格式发送和接收数据
* @version Egret 2.4
* @platform Web,Native
* @language zh_CN
*/
static TYPE_BINARY: string;
/**
* @private
*/
private socket;
/**
* @private
*/
private _writeMessage;
/**
* @private
*/
private _readMessage;
/**
* @private
*/
private _connected;
/**
* @private
*/
private _connecting;
/**
* Create an egret.WebSocket object
* This parameter is reserved for later versions. The connection address and port number are imported in the connect function
* @version Egret 2.4
* @platform Web,Native
* @language en_US
*/
/**
* 创建一个 egret.WebSocket 对象
* 参数为预留参数,现版本暂不处理,连接地址和端口号在 connect 函数中传入
* @version Egret 2.4
* @platform Web,Native
* @language zh_CN
*/
constructor(host?: string, port?: number);
/**
* Connect the socket to the specified host and port number
* @param host Name or IP address of the host to be connected
* @param port Port number to be connected
* @version Egret 2.4
* @platform Web,Native
* @language en_US
*/
/**
* 将套接字连接到指定的主机和端口
* @param host 要连接到的主机的名称或 IP 地址
* @param port 要连接到的端口号
* @version Egret 2.4
* @platform Web,Native
* @language zh_CN
*/
connect(host: string, port: number): void;
/**
* 根据提供的url连接
* @param url 全地址。如ws://echo.websocket.org:80
*/
connectByUrl(url: string): void;
/**
* Closesocket
* @version Egret 2.4
* @platform Web,Native
* @language en_US
*/
/**
* 关闭套接字
* @version Egret 2.4
* @platform Web,Native
* @language zh_CN
*/
close(): void;
/**
* @private
*
*/
private onConnect();
/**
* @private
*
*/
private onClose();
/**
* @private
*
*/
private onError();
/**
* @private
*
* @param message
*/
private onSocketData(message);
/**
* Refresh all data accumulated in the output buffer area of the socket
* @version Egret 2.4
* @platform Web,Native
* @language en_US
*/
/**
* 对套接字输出缓冲区中积累的所有数据进行刷新
* @version Egret 2.4
* @platform Web,Native
* @language zh_CN
*/
flush(): void;
/**
* @private
*/
private _isReadySend;
/**
* Write data in character string in the socket
* @param message The character string to be written in the socket
* @version Egret 2.4
* @platform Web,Native
* @language en_US
*/
/**
* 将字符串数据写入套接字
* @param message 要写入套接字的字符串
* @version Egret 2.4
* @platform Web,Native
* @language zh_CN
*/
writeUTF(message: string): void;
/**
* Read a UTF-8 character string from the socket
* @returns {string}
* @version Egret 2.4
* @platform Web,Native
* @language en_US
*/
/**
* 从套接字读取一个 UTF-8 字符串
* @returns {string}
* @version Egret 2.4
* @platform Web,Native
* @language zh_CN
*/
readUTF(): string;
/**
* @private
*/
private _readByte;
/**
* @private
*/
private _writeByte;
/**
* @private
*/
private _bytesWrite;
/**
* Write a series of bytes from the specified byte array. The writing operation starts from the location expressed by offset.
* If the length parameter is ignored, the default length 0 indicates that data is written from offset in the entire buffer area.
* If the offset parameter is ignored, data is written in the entire buffer area.
* @param bytes The ByteArray object where data is read from
* @param offset Zero-based offset in the ByteArray object. From here start performing data writing
* @param length Number of bytes to be written Default value 0 indicates data is written in the entire buffer area from the value specified by the offset parameter
* @version Egret 2.4
* @platform Web,Native
* @language en_US
*/
/**
* 从指定的字节数组写入一系列字节。写入操作从 offset 指定的位置开始。
* 如果省略了 length 参数,则默认长度 0 将导致该方法从 offset 开始写入整个缓冲区。
* 如果还省略了 offset 参数,则写入整个缓冲区。
* @param bytes 要从中读取数据的 ByteArray 对象
* @param offset ByteArray 对象中从零开始的偏移量,应由此开始执行数据写入
* @param length 要写入的字节数。默认值 0 导致从 offset 参数指定的值开始写入整个缓冲区
* @version Egret 2.4
* @platform Web,Native
* @language zh_CN
*/
writeBytes(bytes: ByteArray, offset?: number, length?: number): void;
/**
* Read data byte number specified by the length parameter from the socket. Read these bytes into the specified byte array starting from the location expressed by offset.
* @param bytes The ByteArray object that data is read into
* @param offset The offset for data reading starts from this byte array
* @param length Byte number to be read Default value 0 indicates reading all available data
* @version Egret 2.4
* @platform Web,Native
* @language en_US
*/
/**
* 从套接字读取 length 参数指定的数据字节数。从 offset 所表示的位置开始,将这些字节读入指定的字节数组
* @param bytes 要将数据读入的 ByteArray 对象
* @param offset 数据读取的偏移量应从该字节数组中开始
* @param length 要读取的字节数。默认值 0 导致读取所有可用的数据
* @version Egret 2.4
* @platform Web,Native
* @language zh_CN
*/
readBytes(bytes: ByteArray, offset?: number, length?: number): void;
/**
* Indicates whether the Socket object is connected currently
* @version Egret 2.4
* @platform Web,Native
* @language en_US
*/
/**
* 表示此 Socket 对象目前是否已连接
* @version Egret 2.4
* @platform Web,Native
* @language zh_CN
*/
readonly connected: boolean;
/**
* @private
*/
private _type;
/**
* Format for sending and receiving data. The default setting is the character string format
* @version Egret 2.4
* @platform Web,Native
* @language en_US
*/
/**
* 发送和接收数据的格式,默认是字符串格式
* @version Egret 2.4
* @platform Web,Native
* @language zh_CN
*/
type: string;
}
}
declare namespace egret.native {
/**
* @private
*/
class NativeSocket implements ISocket {
private socket;
constructor();
private onConnect;
private onClose;
private onSocketData;
private onError;
private thisObject;
addCallBacks(onConnect: Function, onClose: Function, onSocketData: Function, onError: Function, thisObject: any): void;
private host;
private port;
connect(host: string, port: number): void;
connectByUrl(url: string): void;
private _bindEvent();
send(message: any): void;
close(): void;
disconnect(): void;
}
}
declare namespace egret.web {
/**
* @private
*/
class HTML5WebSocket implements ISocket {
private socket;
constructor();
private onConnect;
private onClose;
private onSocketData;
private onError;
private thisObject;
addCallBacks(onConnect: Function, onClose: Function, onSocketData: Function, onError: Function, thisObject: any): void;
private host;
private port;
connect(host: string, port: number): void;
connectByUrl(url: string): void;
private _bindEvent();
send(message: any): void;
close(): void;
disconnect(): void;
}
}