joynr.types.DiscoveryQos.js Maven / Gradle / Ivy

Go to download
/**
 * This is the generated struct type DiscoveryQos: DOCS GENERATED FROM INTERFACE DESCRIPTION
 * Generation date: Thu Aug 18 09:35:51 CEST 2016
 */
(function(undefined) {
	/**
	 * @name DiscoveryQos
	 * @constructor
	 *
	 * @classdesc
	 * This is the generated struct type DiscoveryQos: DOCS GENERATED FROM INTERFACE DESCRIPTION
	 * 
Generation date: Thu Aug 18 09:35:51 CEST 2016
	 * 

Discovery quality of service settings
	 *
	 * @param {Object} members - an object containing the individual member elements
	 * @param {Number} members.cacheMaxAge - The maximum age of a cached entry in milliseconds
	 * @param {Number} members.discoveryTimeout - Discovery TTL
	 * @param {DiscoveryScope} members.discoveryScope - The discovery scope
	 * @param {Boolean} members.providerMustSupportOnChange - True, if the provider is required to support the OnChange publication
	 * @returns {DiscoveryQos} a new instance of a DiscoveryQos
	 */
	var DiscoveryQos = function DiscoveryQos(members) {
		if (!(this instanceof DiscoveryQos)) {
			// in case someone calls constructor without new keyword (e.g. var c = Constructor({..}))
			return new DiscoveryQos(members);
		}

		/**
		 * Used for serialization.
		 * @name DiscoveryQos#_typeName
		 * @type String
		 * @readonly
		 */
		Object.defineProperty(this, "_typeName", {
			configurable : false,
			writable : false,
			enumerable : true,
			value : "joynr.types.DiscoveryQos"
		});

		/**
		 * The maximum age of a cached entry in milliseconds
		 * @name DiscoveryQos#cacheMaxAge
		 * @type Number
		 */
		/**
		 * Discovery TTL
		 * @name DiscoveryQos#discoveryTimeout
		 * @type Number
		 */
		/**
		 * The discovery scope
		 * @name DiscoveryQos#discoveryScope
		 * @type DiscoveryScope
		 */
		/**
		 * True, if the provider is required to support the OnChange publication
		 * @name DiscoveryQos#providerMustSupportOnChange
		 * @type Boolean
		 */
		Object.defineProperty(this, 'checkMembers', {
			enumerable: false,
			value: function checkMembers(check) {
				check(this.cacheMaxAge, "Number", "members.cacheMaxAge");
				check(this.discoveryTimeout, "Number", "members.discoveryTimeout");
				check(this.discoveryScope, ["String", "Object", "DiscoveryScope"], "members.discoveryScope");
				check(this.providerMustSupportOnChange, "Boolean", "members.providerMustSupportOnChange");
			}
		});

		if (members !== undefined) {
			this.cacheMaxAge = members.cacheMaxAge;
			this.discoveryTimeout = members.discoveryTimeout;
			this.discoveryScope = members.discoveryScope;
			this.providerMustSupportOnChange = members.providerMustSupportOnChange;
		}

	};

	/**
	 * @name DiscoveryQos#MAJOR_VERSION
	 * @constant {Number}
	 * @default 0
	 * @summary The MAJOR_VERSION of the struct type DiscoveryQos is GENERATED FROM THE INTERFACE DESCRIPTION
	 */
	Object.defineProperty(DiscoveryQos, 'MAJOR_VERSION', {
		enumerable: false,
		configurable: false,
		writable: false,
		readable: true,
		value: 0
	});
	/**
	 * @name DiscoveryQos#MINOR_VERSION
	 * @constant {Number}
	 * @default 0
	 * @summary The MINOR_VERSION of the struct type DiscoveryQos is GENERATED FROM THE INTERFACE DESCRIPTION
	 */
	Object.defineProperty(DiscoveryQos, 'MINOR_VERSION', {
		enumerable: false,
		configurable: false,
		writable: false,
		readable: true,
		value: 0
	});

	var memberTypes = {
		cacheMaxAge: function() { return "Long"; },
		discoveryTimeout: function() { return "Long"; },
		discoveryScope: function() { return "joynr.types.DiscoveryScope"; },
		providerMustSupportOnChange: function() { return "Boolean"; }
	};
	Object.defineProperty(DiscoveryQos, 'getMemberType', {
		enumerable: false,
		value: function getMemberType(memberName) {
			if (memberTypes[memberName] !== undefined) {
				return memberTypes[memberName]();
			}
			return undefined;
		}
	});

	// AMD support
	if (typeof define === 'function' && define.amd) {
		define("joynr/types/DiscoveryQos", ["joynr"], function (joynr) {
			DiscoveryQos.prototype = new joynr.JoynrObject();
			DiscoveryQos.prototype.constructor = DiscoveryQos;
			joynr.addType("joynr.types.DiscoveryQos", DiscoveryQos);
			return DiscoveryQos;
		});
	} else if (typeof exports !== 'undefined' ) {
		if ((module !== undefined) && module.exports) {
			exports = module.exports = DiscoveryQos;
		} else {
			// support CommonJS module 1.1.1 spec (`exports` cannot be a function)
			exports.DiscoveryQos = DiscoveryQos;
		}
		var joynr = requirejs("joynr");
		DiscoveryQos.prototype = new joynr.JoynrObject();
		DiscoveryQos.prototype.constructor = DiscoveryQos;

		joynr.addType("joynr.types.DiscoveryQos", DiscoveryQos);
	} else {
		DiscoveryQos.prototype = new window.joynr.JoynrObject();
		DiscoveryQos.prototype.constructor = DiscoveryQos;
		window.joynr.addType("joynr.types.DiscoveryQos", DiscoveryQos);
		window.DiscoveryQos = DiscoveryQos;
	}
})();