joynr.infrastructure.GlobalCapabilitiesDirectoryProxy.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
/**
 * PLEASE NOTE: THIS IS A GENERATED FILE!
 * Generation date: Wed Jan 27 16:29:10 CET 2016
 *
 * GlobalCapabilitiesDirectoryProxy, generated from the corresponding interface description.
 */
(function (undefined){
	/**
	 * @name GlobalCapabilitiesDirectoryProxy
	 * @constructor
	 *
	 * @classdesc
	 * 
Generation date: Wed Jan 27 16:29:10 CET 2016
	 * 


	 * GlobalCapabilitiesDirectoryProxy, generated from the corresponding interface description.
	 * 

The GlobalCapabilitiesDirectory is a joynr
	 * internal interface. When a provider that is globally available is
	 * registered with joynr, the framework creates an entry for that provider
	 * in the global capabilities directory. These
	 * CapabilityInformation entries contain access
	 * information as well as supported QoS. The information is later used in
	 * the arbitration process to pick a provider for a proxy.
	 * @see CapabilityInformation
	 *
	 * @param {object} settings the settings object for this function call
	 * @param {String} settings.domain the domain name //TODO: check do we need this?
	 * @param {String} settings.joynrName the interface name //TODO: check do we need this?
	 *
	 * @param {Object} settings.discoveryQos the Quality of Service parameters for arbitration
	 * @param {Number} settings.discoveryQos.discoveryTimeout for rpc calls to wait for arbitration to finish.
	 * @param {String} settings.discoveryQos.arbitrationStrategy Strategy for choosing the appropriate provider from the list returned by the capabilities directory
	 * @param {Number} settings.discoveryQos.cacheMaxAge Maximum age of entries in the localCapabilitiesDirectory. If this value filters out all entries of the local capabilities directory a lookup in the global capabilitiesDirectory will take place.
	 * @param {Boolean} settings.discoveryQos.discoveryScope If localOnly is set to true, only local providers will be considered.
	 * @param {Object} settings.discoveryQos.additionalParameters a map holding additional parameters in the form of key value pairs in the javascript object, e.g.: {"myKey": "myValue", "myKey2": 5}
	 *
	 * @param {object} settings.messagingQos the Quality of Service parameters for messaging
	 * @param {Number} settings.messagingQos.ttl Roundtrip timeout for rpc requests.

	 * @param {Number} settings.dependencies instances of the internal objects needed by the proxy to interface with joynr
	 * @param {Number} settings.proxyElementTypes constructors for attribute, method and broadcasts, used to create the proxy's elements
	 *
	 * @returns {GlobalCapabilitiesDirectoryProxy} a GlobalCapabilitiesDirectoryProxy object to access other providers
	 */
	var GlobalCapabilitiesDirectoryProxy = function GlobalCapabilitiesDirectoryProxy(
		settings) {
		if (!(this instanceof GlobalCapabilitiesDirectoryProxy)) {
			// in case someone calls constructor without new keyword (e.g. var c = Constructor({..}))
			return new GlobalCapabilitiesDirectoryProxy(
				settings);
		}

		// generated package name
		this.settings = settings || {};


		/**
		 * @function GlobalCapabilitiesDirectoryProxy#add
		 * @summary The add operation is GENERATED FROM THE INTERFACE DESCRIPTION
		 * 
method overloading: different call semantics possible
		 * 

Registers a list of capability information with the
		 * directory.
		 *
		 * @param {Array.} capabilities -
		 * the list of capabilities to register
		 */
		/**
		 * @function GlobalCapabilitiesDirectoryProxy#add
		 * @summary The add operation is GENERATED FROM THE INTERFACE DESCRIPTION
		 * 
method overloading: different call semantics possible
		 * 

Registers capability information with the directory.
		 *
		 * @param {CapabilityInformation} capability -
		 * the capability to register
		 */
		this.add = new settings.proxyElementTypes.ProxyOperation(this, settings, "add", [
			{
				inputParameter: [
				{
					name : "capabilities",
					type : "joynr.types.CapabilityInformation[]"
				}
				],
				outputParameter: [
				]
			},			{
				inputParameter: [
				{
					name : "capability",
					type : "joynr.types.CapabilityInformation"
				}
				],
				outputParameter: [
				]
			}
		]).buildFunction();
		/**
		 * @function GlobalCapabilitiesDirectoryProxy#lookup
		 * @summary The lookup operation is GENERATED FROM THE INTERFACE DESCRIPTION
		 * 
method overloading: different call semantics possible
		 * 

Looks up a list of capabilities for a given domain,
		 * interface name and provider QoS.
		 *
		 * @param {String} domain -
		 * the name of the domain
		 * @param {String} interfaceName -
		 * the interface name of the capability
		 * @returns {Array.} result -
		 * a list of matching capabilities
		 */
		/**
		 * @function GlobalCapabilitiesDirectoryProxy#lookup
		 * @summary The lookup operation is GENERATED FROM THE INTERFACE DESCRIPTION
		 * 
method overloading: different call semantics possible
		 * 

Looks up the capability information for a given
		 * participant ID.
		 *
		 * @param {String} participantId -
		 * the participant ID identifying the provider
		 * @returns {CapabilityInformation} result -
		 * the matching capability
		 */
		this.lookup = new settings.proxyElementTypes.ProxyOperation(this, settings, "lookup", [
			{
				inputParameter: [
				{
					name : "domain",
					type : "String"
				},
				{
					name : "interfaceName",
					type : "String"
				}
				],
				outputParameter: [
					{
						name : "result",
						type : "joynr.types.CapabilityInformation[]"
					}
				]
			},			{
				inputParameter: [
				{
					name : "participantId",
					type : "String"
				}
				],
				outputParameter: [
					{
						name : "result",
						type : "joynr.types.CapabilityInformation"
					}
				]
			}
		]).buildFunction();
		/**
		 * @function GlobalCapabilitiesDirectoryProxy#remove
		 * @summary The remove operation is GENERATED FROM THE INTERFACE DESCRIPTION
		 * 
method overloading: different call semantics possible
		 * 

Unregisters a list of capabilities from the directory.
		 *
		 * @param {Array.} participantIds -
		 * the list of participant IDs, for which the
		 * capability has to be removed
		 */
		/**
		 * @function GlobalCapabilitiesDirectoryProxy#remove
		 * @summary The remove operation is GENERATED FROM THE INTERFACE DESCRIPTION
		 * 
method overloading: different call semantics possible
		 * 

Unregisters a capability from the directory.
		 *
		 * @param {String} participantId -
		 * the participant ID for which the capability has
		 * to be removed
		 */
		this.remove = new settings.proxyElementTypes.ProxyOperation(this, settings, "remove", [
			{
				inputParameter: [
				{
					name : "participantIds",
					type : "String[]"
				}
				],
				outputParameter: [
				]
			},			{
				inputParameter: [
				{
					name : "participantId",
					type : "String"
				}
				],
				outputParameter: [
				]
			}
		]).buildFunction();


		Object.defineProperty(this, "interfaceName", {
			writable: false,
			readable: true,
			value: "infrastructure/GlobalCapabilitiesDirectory"
		});
	};

	GlobalCapabilitiesDirectoryProxy.getUsedDatatypes = function getUsedDatatypes(){
		return [
					"joynr.types.CapabilityInformation"
				];
	};

	// AMD support
	if (typeof define === 'function' && define.amd) {
		define("joynr/infrastructure/GlobalCapabilitiesDirectoryProxy", [
			"joynr/types/CapabilityInformation"
			], function () {
				return GlobalCapabilitiesDirectoryProxy;
			});
	} else if (typeof exports !== 'undefined' ) {
		if ((module !== undefined) && module.exports) {
			require("../../joynr/types/CapabilityInformation");
			exports = module.exports = GlobalCapabilitiesDirectoryProxy;
		}
		else {
			// support CommonJS module 1.1.1 spec (`exports` cannot be a function)
			exports.GlobalCapabilitiesDirectoryProxy = GlobalCapabilitiesDirectoryProxy;
		}
	} else {
		window.GlobalCapabilitiesDirectoryProxy = GlobalCapabilitiesDirectoryProxy;
	}
})();