joynr.infrastructure.ChannelUrlDirectoryProxy.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: Fri Nov 20 11:55:23 CET 2015
 *
 * ChannelUrlDirectoryProxy, generated from the corresponding interface description.
 */
(function (undefined){
	/**
	 * @name ChannelUrlDirectoryProxy
	 * @constructor
	 *
	 * @classdesc
	 * 
Generation date: Fri Nov 20 11:55:23 CET 2015
	 * 


	 * ChannelUrlDirectoryProxy, generated from the corresponding interface description.
	 * 

The ChannelUrlDirectory interface defines the
	 * interface of the joynr internal channel URL directory. The channel URL
	 * directory is a joynr infrastructure backend component that resolves
	 * channel IDs to channel URLs. A joynr Cluster Controller is addressed
	 * using a unique channel ID. However, the channel ID can be mapped on
	 * multiple channel URLs depending on network topology and reachability.
	 *
	 * @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 {ChannelUrlDirectoryProxy} a ChannelUrlDirectoryProxy object to access other providers
	 */
	var ChannelUrlDirectoryProxy = function ChannelUrlDirectoryProxy(
		settings) {
		if (!(this instanceof ChannelUrlDirectoryProxy)) {
			// in case someone calls constructor without new keyword (e.g. var c = Constructor({..}))
			return new ChannelUrlDirectoryProxy(
				settings);
		}

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


		/**
		 * @function ChannelUrlDirectoryProxy#unregisterChannelUrls
		 * @summary The unregisterChannelUrls operation is GENERATED FROM THE INTERFACE DESCRIPTION
		 * 

Deletes all ChannelUrlInformation that
		 * is registered with the channel URL directory for the given channel ID.
		 * @see ChannelUrlInformation
		 *
		 * @param {String} channelId -
		 * the channel ID to remove from the directory
		 */
		this.unregisterChannelUrls = new settings.proxyElementTypes.ProxyOperation(this, settings, "unregisterChannelUrls", [
			{
				inputParameter: [
				{
					name : "channelId",
					type : TypesEnum.STRING
				}
				],
				outputParameter: [
				]
			}
		]).buildFunction();
		/**
		 * @function ChannelUrlDirectoryProxy#getUrlsForChannel
		 * @summary The getUrlsForChannel operation is GENERATED FROM THE INTERFACE DESCRIPTION
		 * 

Gets ChannelUrlInformation from the
		 * channel URL directory for a given channel ID.
		 * @see ChannelUrlInformation
		 *
		 * @param {String} channelId -
		 * the channel ID to lookup
		 * @returns {ChannelUrlInformation} result -
		 * channel URL information to reach the given
		 * channel ID
		 */
		this.getUrlsForChannel = new settings.proxyElementTypes.ProxyOperation(this, settings, "getUrlsForChannel", [
			{
				inputParameter: [
				{
					name : "channelId",
					type : TypesEnum.STRING
				}
				],
				outputParameter: [
					{
						name : "result",
						type : "joynr.types.ChannelUrlInformation"
					}
				]
			}
		]).buildFunction();
		/**
		 * @function ChannelUrlDirectoryProxy#registerChannelUrls
		 * @summary The registerChannelUrls operation is GENERATED FROM THE INTERFACE DESCRIPTION
		 * 

Registers ChannelUrlInformation for
		 * a channel ID. The channel URL information is used to send messages
		 * to a Cluster Controller identified by the unique channel ID.
		 * @see ChannelUrlInformation
		 *
		 * @param {String} channelId -
		 * the channel ID to register channel URL information
		 * with
		 * @param {ChannelUrlInformation} channelUrlInformation -
		 * the channel URL information used to send messages
		 * to a Cluster Controller
		 */
		this.registerChannelUrls = new settings.proxyElementTypes.ProxyOperation(this, settings, "registerChannelUrls", [
			{
				inputParameter: [
				{
					name : "channelId",
					type : TypesEnum.STRING
				},
				{
					name : "channelUrlInformation",
					type : "joynr.types.ChannelUrlInformation"
				}
				],
				outputParameter: [
				]
			}
		]).buildFunction();


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

	ChannelUrlDirectoryProxy.getUsedDatatypes = function getUsedDatatypes(){
		return [
					"joynr.types.ChannelUrlInformation"
				];
	};

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