Initial working version
This commit is contained in:
+72
@@ -0,0 +1,72 @@
|
||||
import Emitter = require("component-emitter");
|
||||
/**
|
||||
* Protocol version.
|
||||
*
|
||||
* @public
|
||||
*/
|
||||
export declare const protocol: number;
|
||||
export declare enum PacketType {
|
||||
CONNECT = 0,
|
||||
DISCONNECT = 1,
|
||||
EVENT = 2,
|
||||
ACK = 3,
|
||||
CONNECT_ERROR = 4,
|
||||
BINARY_EVENT = 5,
|
||||
BINARY_ACK = 6
|
||||
}
|
||||
export interface Packet {
|
||||
type: PacketType;
|
||||
nsp: string;
|
||||
data?: any;
|
||||
id?: number;
|
||||
attachments?: number;
|
||||
}
|
||||
/**
|
||||
* A socket.io Encoder instance
|
||||
*/
|
||||
export declare class Encoder {
|
||||
/**
|
||||
* Encode a packet as a single string if non-binary, or as a
|
||||
* buffer sequence, depending on packet type.
|
||||
*
|
||||
* @param {Object} obj - packet object
|
||||
*/
|
||||
encode(obj: Packet): any[];
|
||||
/**
|
||||
* Encode packet as string.
|
||||
*/
|
||||
private encodeAsString;
|
||||
/**
|
||||
* Encode packet as 'buffer sequence' by removing blobs, and
|
||||
* deconstructing packet into object with placeholders and
|
||||
* a list of buffers.
|
||||
*/
|
||||
private encodeAsBinary;
|
||||
}
|
||||
/**
|
||||
* A socket.io Decoder instance
|
||||
*
|
||||
* @return {Object} decoder
|
||||
*/
|
||||
export declare class Decoder extends Emitter {
|
||||
private reconstructor;
|
||||
constructor();
|
||||
/**
|
||||
* Decodes an encoded packet string into packet JSON.
|
||||
*
|
||||
* @param {String} obj - encoded packet
|
||||
*/
|
||||
add(obj: any): void;
|
||||
/**
|
||||
* Decode a packet String (JSON data)
|
||||
*
|
||||
* @param {String} str
|
||||
* @return {Object} packet
|
||||
*/
|
||||
private decodeString;
|
||||
private static isPayloadValid;
|
||||
/**
|
||||
* Deallocates a parser's resources
|
||||
*/
|
||||
destroy(): void;
|
||||
}
|
||||
Reference in New Issue
Block a user