@jayesol/jayeson.lib.delivery 2.0.7-beta.0 → 2.0.7

package/lib/CoreMessages.js

@@ -1,248 +1,248 @@
-var util = require("./util")
-var _c = util._c
-var _ = require("underscore")
-var DeliveryStack = require("./DeliveryStack")
-var IMessageGroup = DeliveryStack.IMessageGroup
-var IMessageClass = DeliveryStack.IMessageClass
-
-/**
- * This javascript file define some default message group and classes
- * That is commonly used
- */
-
-/****************** MESSAGE CLASS DEFINITIONS *******************/
-/**
- * Empty Message Class
- */
-function EmptyMessageClass(group, id) {
-	IMessageClass.call(this, group, id, String);
-	this.inH = {
-		unpack: function (wrapper) {	// this unpack method convert undefined to "" for easy handling at processor / hook
-			if (wrapper.message === undefined || wrapper.message === null) wrapper.message = "";
-		}
-	};
-
-	this.outH = {
-		pack: function (wrapper) {
-			// in whatever case, the message sent in an empty message should 
-			// be encoded into an empty byte array, regardless of what the user set
-			wrapper.message = [];
-		}
-	}
-}
-_c(EmptyMessageClass, {
-	inHandlers: function () {	// in handlers of the empty message class does nothing
-		return [this.inH];
-	},
-
-	outHandlers: function () {
-		return [this.outH];
-	}
-}, IMessageClass);
-
-/**
- * String message class, decode (encode) from  byte[] (string) to string (byte[])
- * @param group
- * @param id
- */
-function StringMessageClass(group, id) {
-	EmptyMessageClass.call(this, group, id);
-	this.inH = {
-		unpack: function (wrapper) {
-			var msg = "";
-			for (var i = 0; i < wrapper.message.length; i++) {
-				msg += String.fromCharCode(wrapper.message[i]);
-			}
-			wrapper.message = msg;
-		}
-	}
-
-	this.outH = {
-		pack: function (wrapper) {
-			var result = [];
-			for (var i = 0; i < wrapper.message.length; i++) {
-				result.push(wrapper.message.charCodeAt(i));
-			}
-			wrapper.message = result;
-		}
-	}
-}
-_c(StringMessageClass, {
-
-	outHandlers: function () {
-		return [this.outH];
-	}
-
-}, EmptyMessageClass);
-
-function JSonMessageClass(group, id, instanceClass) {
-	IMessageClass.call(this, group, id, String);
-
-	this.inH = {
-		unpack: function (wrapper) {
-			// convert from byte[] to json object
-			var msg = "";
-			for (var i = 0; i < wrapper.message.length; i++) {
-				msg += String.fromCharCode(wrapper.message[i]);
-			}
-			var obj = JSON.parse(msg);	// convert into a message
-			var actual = new instanceClass();
-			_.extend(actual, obj);		// copy data into the object of the correct type
-
-			wrapper.message = actual;
-		}
-	};
-
-	this.outH = {
-		pack: function (wrapper) {
-			var msg = JSON.stringify(wrapper.message);	// convert original message to string
-			var result = [];
-			for (var i = 0; i < msg.length; i++) {
-				result.push(msg.charCodeAt(i));
-			}
-
-			wrapper.message = result;					// update wrapper
-		}
-	};
-}
-_c(JSonMessageClass, {
-	inHandlers: function () {
-		return [this.inH];
-	},
-
-	outHandlers: function () {
-		return [this.outH];
-	}
-}, IMessageClass);
-
-/******************** CORE MESSAGE GROUP DEFINITIONS ****************/
-
-function GenericMessageGroup() {
-	IMessageGroup.call(this, 6);
-	this._classes = [
-		new StringMessageClass(this, 0)
-	];
-};
-_c(GenericMessageGroup, {}, IMessageGroup);
-GenericMessageGroup = new GenericMessageGroup();		// singleton
-
-function KeepAliveMessageGroup() {
-	IMessageGroup.call(this, 4);
-	this._classes = [
-		new EmptyMessageClass(this, 0)
-	];
-};
-_c(KeepAliveMessageGroup, {}, IMessageGroup);
-KeepAliveMessageGroup = new KeepAliveMessageGroup();	// singleton
-
-/**************** AUTH MESSAGE GROUP DEFINITION **********************/
-
-// bean definition for the general response
-function GeneralResponse(status, message) {
-	this.status = status;
-	this.message = message;
-}
-_c(GeneralResponse, {
-	getStatus: function () { return this.status; },
-	getMessage: function () { return this.message; }
-});
-
-//bean definition for the ticket renew
-function TicketRenew(clientId, newTicket) {
-	this.clientId = clientId;
-	this.newTicket = newTicket;
-}
-_c(GeneralResponse, {
-	getClientId: function () { return this.clientId; },
-	getNewTicket: function () { return this.newTicket; }
-});
-
-function AuthGroup() {
-	IMessageGroup.call(this, 5);
-
-	this.GENERAL_RESPONSE = new JSonMessageClass(this, 0, GeneralResponse);
-	this.HTTP_AUTH = new EmptyMessageClass(this, 1);
-	this.TCP_AUTH = new EmptyMessageClass(this, 2);
-	this.TICKET_RENEW = new JSonMessageClass(this, 3, TicketRenew);
-	this.STRING = new StringMessageClass(this, 4);
-
-	this._classes = [
-		this.GENERAL_RESPONSE,
-		// this is corresponding HTTP_AUTH_CONTENT, since we are sending auth content
-		// using XHR we don't need to define any handlers for this message class
-		this.HTTP_AUTH,
-		// this correspond to tcp auth content. We are not sending auth content through tcp,
-		// so ignore this
-		this.TCP_AUTH,
-		// ticket renew
-		this.TICKET_RENEW,
-		// generic string
-		this.STRING
-
-
-	];
-}
-_c(AuthGroup, {}, IMessageGroup);
-AuthGroup = new AuthGroup();	// singleton
-
-/**************** STREAM REGISTRATION GROUP **********************/
-function StreamRegistryRequest(messageGroup, streams, requestType) {
-	this.messageGroup = messageGroup;
-	this.streams = streams;
-	this.requestType = requestType;
-}
-_.extend(StreamRegistryRequest, {
-	REGISTRATION: 0,
-	CONSUMPTION: 1,
-	DEREGISTRATION: 2
-});
-
-/**
- * It is guaranteed by the stream registry service that if I sent a registration message
- * for Group A Stream X, Y, Z, the response will contains the information for all the stream X, Y, Z.
- * 
- * @param: messageGroup - the message group i'm registered for
- * @param: streams - a map from stream name to the registration status, can be SUCCESS (4) or FAILED (5)
- * @param: responseType - type of the response, can be REGISTRATION, CONSUMPTION, DEREGISTRATION
- *
- */
-function StreamRegistryResponse(messageGroup, streams, responseType) {
-	this.messageGroup = messageGroup;
-	this.streams = streams;
-	this.responseType = responseType;
-}
-_.extend(StreamRegistryResponse, {
-	REGISTRATION: 0,
-	CONSUMPTION: 1,
-	STOP_CONSUMPTION: 6,
-	DEREGISTRATION: 2,
-	GENERAL: 3,
-
-	SUCCESS: 4,
-	FAILED: 5,
-	DEREGISTRATION_TIMEOUT: 7
-});
-
-function StreamRegistryMessageGroup() {
-	IMessageGroup.call(this, 2);
-
-	this.REQUEST = new JSonMessageClass(this, 0, StreamRegistryRequest);
-	this.RESPONSE = new JSonMessageClass(this, 1, StreamRegistryResponse);
-
-	this._classes = [this.REQUEST, this.RESPONSE];
-}
-_c(StreamRegistryMessageGroup, {}, IMessageGroup);					// inherit from IMessageGroup
-StreamRegistryMessageGroup = new StreamRegistryMessageGroup();		// singleton
-
-module.exports = exports = {
-	StreamRegistryMessageGroup: StreamRegistryMessageGroup,
-	EmptyMessageClass: EmptyMessageClass,
-	StringMessageClass: StringMessageClass,
-	JSonMessageClass: JSonMessageClass,
-	StreamRegistryRequest: StreamRegistryRequest,
-	StreamRegistryResponse: StreamRegistryResponse,
-	AuthGroup: AuthGroup,
-	GenericMessageGroup: GenericMessageGroup,
-	KeepAliveMessageGroup: KeepAliveMessageGroup,
-	TicketRenew: TicketRenew
-}
+var util = require("./util")
+var _c = util._c
+var _ = require("underscore")
+var DeliveryStack = require("./DeliveryStack")
+var IMessageGroup = DeliveryStack.IMessageGroup
+var IMessageClass = DeliveryStack.IMessageClass
+
+/**
+ * This javascript file define some default message group and classes
+ * That is commonly used
+ */
+
+/****************** MESSAGE CLASS DEFINITIONS *******************/
+/**
+ * Empty Message Class
+ */
+function EmptyMessageClass(group, id) {
+	IMessageClass.call(this, group, id, String);
+	this.inH = {
+		unpack: function (wrapper) {	// this unpack method convert undefined to "" for easy handling at processor / hook
+			if (wrapper.message === undefined || wrapper.message === null) wrapper.message = "";
+		}
+	};
+
+	this.outH = {
+		pack: function (wrapper) {
+			// in whatever case, the message sent in an empty message should 
+			// be encoded into an empty byte array, regardless of what the user set
+			wrapper.message = [];
+		}
+	}
+}
+_c(EmptyMessageClass, {
+	inHandlers: function () {	// in handlers of the empty message class does nothing
+		return [this.inH];
+	},
+
+	outHandlers: function () {
+		return [this.outH];
+	}
+}, IMessageClass);
+
+/**
+ * String message class, decode (encode) from  byte[] (string) to string (byte[])
+ * @param group
+ * @param id
+ */
+function StringMessageClass(group, id) {
+	EmptyMessageClass.call(this, group, id);
+	this.inH = {
+		unpack: function (wrapper) {
+			var msg = "";
+			for (var i = 0; i < wrapper.message.length; i++) {
+				msg += String.fromCharCode(wrapper.message[i]);
+			}
+			wrapper.message = msg;
+		}
+	}
+
+	this.outH = {
+		pack: function (wrapper) {
+			var result = [];
+			for (var i = 0; i < wrapper.message.length; i++) {
+				result.push(wrapper.message.charCodeAt(i));
+			}
+			wrapper.message = result;
+		}
+	}
+}
+_c(StringMessageClass, {
+
+	outHandlers: function () {
+		return [this.outH];
+	}
+
+}, EmptyMessageClass);
+
+function JSonMessageClass(group, id, instanceClass) {
+	IMessageClass.call(this, group, id, String);
+
+	this.inH = {
+		unpack: function (wrapper) {
+			// convert from byte[] to json object
+			var msg = "";
+			for (var i = 0; i < wrapper.message.length; i++) {
+				msg += String.fromCharCode(wrapper.message[i]);
+			}
+			var obj = JSON.parse(msg);	// convert into a message
+			var actual = new instanceClass();
+			_.extend(actual, obj);		// copy data into the object of the correct type
+
+			wrapper.message = actual;
+		}
+	};
+
+	this.outH = {
+		pack: function (wrapper) {
+			var msg = JSON.stringify(wrapper.message);	// convert original message to string
+			var result = [];
+			for (var i = 0; i < msg.length; i++) {
+				result.push(msg.charCodeAt(i));
+			}
+
+			wrapper.message = result;					// update wrapper
+		}
+	};
+}
+_c(JSonMessageClass, {
+	inHandlers: function () {
+		return [this.inH];
+	},
+
+	outHandlers: function () {
+		return [this.outH];
+	}
+}, IMessageClass);
+
+/******************** CORE MESSAGE GROUP DEFINITIONS ****************/
+
+function GenericMessageGroup() {
+	IMessageGroup.call(this, 6);
+	this._classes = [
+		new StringMessageClass(this, 0)
+	];
+};
+_c(GenericMessageGroup, {}, IMessageGroup);
+GenericMessageGroup = new GenericMessageGroup();		// singleton
+
+function KeepAliveMessageGroup() {
+	IMessageGroup.call(this, 4);
+	this._classes = [
+		new EmptyMessageClass(this, 0)
+	];
+};
+_c(KeepAliveMessageGroup, {}, IMessageGroup);
+KeepAliveMessageGroup = new KeepAliveMessageGroup();	// singleton
+
+/**************** AUTH MESSAGE GROUP DEFINITION **********************/
+
+// bean definition for the general response
+function GeneralResponse(status, message) {
+	this.status = status;
+	this.message = message;
+}
+_c(GeneralResponse, {
+	getStatus: function () { return this.status; },
+	getMessage: function () { return this.message; }
+});
+
+//bean definition for the ticket renew
+function TicketRenew(clientId, newTicket) {
+	this.clientId = clientId;
+	this.newTicket = newTicket;
+}
+_c(GeneralResponse, {
+	getClientId: function () { return this.clientId; },
+	getNewTicket: function () { return this.newTicket; }
+});
+
+function AuthGroup() {
+	IMessageGroup.call(this, 5);
+
+	this.GENERAL_RESPONSE = new JSonMessageClass(this, 0, GeneralResponse);
+	this.HTTP_AUTH = new EmptyMessageClass(this, 1);
+	this.TCP_AUTH = new EmptyMessageClass(this, 2);
+	this.TICKET_RENEW = new JSonMessageClass(this, 3, TicketRenew);
+	this.STRING = new StringMessageClass(this, 4);
+
+	this._classes = [
+		this.GENERAL_RESPONSE,
+		// this is corresponding HTTP_AUTH_CONTENT, since we are sending auth content
+		// using XHR we don't need to define any handlers for this message class
+		this.HTTP_AUTH,
+		// this correspond to tcp auth content. We are not sending auth content through tcp,
+		// so ignore this
+		this.TCP_AUTH,
+		// ticket renew
+		this.TICKET_RENEW,
+		// generic string
+		this.STRING
+
+
+	];
+}
+_c(AuthGroup, {}, IMessageGroup);
+AuthGroup = new AuthGroup();	// singleton
+
+/**************** STREAM REGISTRATION GROUP **********************/
+function StreamRegistryRequest(messageGroup, streams, requestType) {
+	this.messageGroup = messageGroup;
+	this.streams = streams;
+	this.requestType = requestType;
+}
+_.extend(StreamRegistryRequest, {
+	REGISTRATION: 0,
+	CONSUMPTION: 1,
+	DEREGISTRATION: 2
+});
+
+/**
+ * It is guaranteed by the stream registry service that if I sent a registration message
+ * for Group A Stream X, Y, Z, the response will contains the information for all the stream X, Y, Z.
+ * 
+ * @param: messageGroup - the message group i'm registered for
+ * @param: streams - a map from stream name to the registration status, can be SUCCESS (4) or FAILED (5)
+ * @param: responseType - type of the response, can be REGISTRATION, CONSUMPTION, DEREGISTRATION
+ *
+ */
+function StreamRegistryResponse(messageGroup, streams, responseType) {
+	this.messageGroup = messageGroup;
+	this.streams = streams;
+	this.responseType = responseType;
+}
+_.extend(StreamRegistryResponse, {
+	REGISTRATION: 0,
+	CONSUMPTION: 1,
+	STOP_CONSUMPTION: 6,
+	DEREGISTRATION: 2,
+	GENERAL: 3,
+
+	SUCCESS: 4,
+	FAILED: 5,
+	DEREGISTRATION_TIMEOUT: 7
+});
+
+function StreamRegistryMessageGroup() {
+	IMessageGroup.call(this, 2);
+
+	this.REQUEST = new JSonMessageClass(this, 0, StreamRegistryRequest);
+	this.RESPONSE = new JSonMessageClass(this, 1, StreamRegistryResponse);
+
+	this._classes = [this.REQUEST, this.RESPONSE];
+}
+_c(StreamRegistryMessageGroup, {}, IMessageGroup);					// inherit from IMessageGroup
+StreamRegistryMessageGroup = new StreamRegistryMessageGroup();		// singleton
+
+module.exports = exports = {
+	StreamRegistryMessageGroup: StreamRegistryMessageGroup,
+	EmptyMessageClass: EmptyMessageClass,
+	StringMessageClass: StringMessageClass,
+	JSonMessageClass: JSonMessageClass,
+	StreamRegistryRequest: StreamRegistryRequest,
+	StreamRegistryResponse: StreamRegistryResponse,
+	AuthGroup: AuthGroup,
+	GenericMessageGroup: GenericMessageGroup,
+	KeepAliveMessageGroup: KeepAliveMessageGroup,
+	TicketRenew: TicketRenew
+}