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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of libjoynr-js Show documentation
JOYnr JavaScript libjoynr-js
The newest version!
/**
 * This is the generated struct type DiscoveryQos: DOCS GENERATED FROM INTERFACE DESCRIPTION
 * Generation date: Mon Jul 09 14:02:45 CEST 2018
 */
(function(undefined) {
	/**
	 * @name DiscoveryQos
	 * @constructor
	 *
	 * @classdesc
	 * This is the generated struct type DiscoveryQos: DOCS GENERATED FROM INTERFACE DESCRIPTION
	 * 
Generation date: Mon Jul 09 14:02:45 CEST 2018
	 * 

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", {
			enumerable : true,
			value : DiscoveryQos._typeName
		});

		/**
		 * 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
		 */

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

	};

	Object.defineProperty(DiscoveryQos, "_typeName", {
		value : "joynr.types.DiscoveryQos"
	});

	Object.defineProperty(DiscoveryQos, 'checkMembers', {
		value: function checkMembers(instance, check) {
			check(instance.cacheMaxAge, "Number", "members.cacheMaxAge");
			check(instance.discoveryTimeout, "Number", "members.discoveryTimeout");
			check(instance.discoveryScope, "DiscoveryScope", "members.discoveryScope");
			check(instance.providerMustSupportOnChange, "Boolean", "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', { 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', { value: 0 });

	var preparePrototype = function(joynr) {
		DiscoveryQos.prototype = new joynr.JoynrObject();
		DiscoveryQos.prototype.constructor = DiscoveryQos;
		joynr.util.GenerationUtil.addEqualsCompound(DiscoveryQos);
		joynr.util.GenerationUtil.addMemberTypeGetter(DiscoveryQos);
	};

	Object.defineProperty(DiscoveryQos, '_memberTypes', {
		value: {
			cacheMaxAge: "Long",
			discoveryTimeout: "Long",
			discoveryScope: "joynr.types.DiscoveryScope",
			providerMustSupportOnChange: "Boolean"
		}
	});

	var joynr = require("joynr");
	preparePrototype(joynr);
	joynr.addType("joynr.types.DiscoveryQos", DiscoveryQos);
	module.exports = DiscoveryQos;
})();