joynr.types.GlobalDiscoveryEntry.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
There is a newer version: 1.4.0
/**
 * This is the generated struct type GlobalDiscoveryEntry: DOCS GENERATED FROM INTERFACE DESCRIPTION
 * Generation date: Fri Jun 29 14:35:22 CEST 2018
 */
(function(undefined) {
	/**
	 * @name GlobalDiscoveryEntry
	 * @constructor
	 *
	 * @classdesc
	 * This is the generated struct type GlobalDiscoveryEntry: DOCS GENERATED FROM INTERFACE DESCRIPTION
	 * 
Generation date: Fri Jun 29 14:35:22 CEST 2018
	 * 

GlobalDiscoveryEntry stores information about a provider instance and extends
	 * DiscoveryEntry by adding transport middleware specific address information.
	 * GlobalDiscoveryEntry objects are used to register a new provider instance with the backend.
	 * In addition, objects of GlobalDiscoveryEntry will be returned by the backend during the
	 * arbitration process in order to select a suitable provider for a proxy.
	 * @see DiscoveryEntry
	 *
	 * @param {Object} members - an object containing the individual member elements
	 * @param {Version} members.providerVersion - semantic version information
	 * @param {String} members.domain - the domain to register the provider with
	 * @param {String} members.interfaceName - the name of the provider interface
	 * @param {String} members.participantId - the participant ID of the provider
	 * @param {ProviderQos} members.qos - the qos of the provider
	 * @param {Number} members.lastSeenDateMs - the date in millis since epoch when the source for this provider last
	 * 			contacted the directory
	 * @param {Number} members.expiryDateMs - the date in millis since epoch when this entry can be purged from the
	 * 			directory and caches
	 * @param {String} members.publicKeyId - the ID of the public key to be used to encrypt messages to
	 * 		this provider
	 * @param {String} members.address - the serialized transport-middleware-specific address where the provider can
	 * 			be reached. The address is a subclass of Address and is stored as a JSON string.
	 * @returns {GlobalDiscoveryEntry} a new instance of a GlobalDiscoveryEntry
	 */
	var GlobalDiscoveryEntry = function GlobalDiscoveryEntry(members) {
		if (!(this instanceof GlobalDiscoveryEntry)) {
			// in case someone calls constructor without new keyword (e.g. var c = Constructor({..}))
			return new GlobalDiscoveryEntry(members);
		}

		/**
		 * Used for serialization.
		 * @name GlobalDiscoveryEntry#_typeName
		 * @type String
		 * @readonly
		 */
		Object.defineProperty(this, "_typeName", {
			enumerable : true,
			value : GlobalDiscoveryEntry._typeName
		});

		/**
		 * Parent class.
		 * @name GlobalDiscoveryEntry#_extends
		 * @type String
		 * @readonly
		 */
		Object.defineProperty(this, "_extends", {
			value : "joynr.types.DiscoveryEntry"
		});

		/**
		 * semantic version information
		 * @name GlobalDiscoveryEntry#providerVersion
		 * @type Version
		 */
		/**
		 * the domain to register the provider with
		 * @name GlobalDiscoveryEntry#domain
		 * @type String
		 */
		/**
		 * the name of the provider interface
		 * @name GlobalDiscoveryEntry#interfaceName
		 * @type String
		 */
		/**
		 * the participant ID of the provider
		 * @name GlobalDiscoveryEntry#participantId
		 * @type String
		 */
		/**
		 * the qos of the provider
		 * @name GlobalDiscoveryEntry#qos
		 * @type ProviderQos
		 */
		/**
		 * the date in millis since epoch when the source for this provider last
		 * 			contacted the directory
		 * @name GlobalDiscoveryEntry#lastSeenDateMs
		 * @type Number
		 */
		/**
		 * the date in millis since epoch when this entry can be purged from the
		 * 			directory and caches
		 * @name GlobalDiscoveryEntry#expiryDateMs
		 * @type Number
		 */
		/**
		 * the ID of the public key to be used to encrypt messages to
		 * 		this provider
		 * @name GlobalDiscoveryEntry#publicKeyId
		 * @type String
		 */
		/**
		 * the serialized transport-middleware-specific address where the provider can
		 * 			be reached. The address is a subclass of Address and is stored as a JSON string.
		 * @name GlobalDiscoveryEntry#address
		 * @type String
		 */

		if (members !== undefined) {
			this.providerVersion = members.providerVersion;
			this.domain = members.domain;
			this.interfaceName = members.interfaceName;
			this.participantId = members.participantId;
			this.qos = members.qos;
			this.lastSeenDateMs = members.lastSeenDateMs;
			this.expiryDateMs = members.expiryDateMs;
			this.publicKeyId = members.publicKeyId;
			this.address = members.address;
		}

	};

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

	Object.defineProperty(GlobalDiscoveryEntry, 'checkMembers', {
		value: function checkMembers(instance, check) {
			check(instance.providerVersion, ["Object", "Version"], "members.providerVersion");
			check(instance.domain, "String", "members.domain");
			check(instance.interfaceName, "String", "members.interfaceName");
			check(instance.participantId, "String", "members.participantId");
			check(instance.qos, ["Object", "ProviderQos"], "members.qos");
			check(instance.lastSeenDateMs, "Number", "members.lastSeenDateMs");
			check(instance.expiryDateMs, "Number", "members.expiryDateMs");
			check(instance.publicKeyId, "String", "members.publicKeyId");
			check(instance.address, "String", "members.address");
		}
	});

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

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

	Object.defineProperty(GlobalDiscoveryEntry, '_memberTypes', {
		value: {
			providerVersion: "joynr.types.Version",
			domain: "String",
			interfaceName: "String",
			participantId: "String",
			qos: "joynr.types.ProviderQos",
			lastSeenDateMs: "Long",
			expiryDateMs: "Long",
			publicKeyId: "String",
			address: "String"
		}
	});

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