joynr.infrastructure.GlobalCapabilitiesDirectoryProxy.js Maven / Gradle / Ivy
/**
* PLEASE NOTE: THIS IS A GENERATED FILE!
* Generation date: Thu Aug 18 09:35:51 CEST 2016
*
* GlobalCapabilitiesDirectoryProxy, generated from the corresponding interface description.
*/
(function (undefined){
/**
* @name GlobalCapabilitiesDirectoryProxy
* @constructor
*
* @classdesc
*
Generation date: Thu Aug 18 09:35:51 CEST 2016
*
* GlobalCapabilitiesDirectoryProxy, generated from the corresponding interface description.
*
The GlobalCapabilitiesDirectory is a joynr
* internal interface. The joynr framework uses it to register
* providers, which are available at a global scope, with the backend.
* A provider is registered along with parameters which will be used
* during the arbitration process to select a suitable provider for
* a proxy. These information are stored in GlobalDiscoveryEntry objects.
* @see GlobalDiscoveryEntry
*
* @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.discoveryTimeoutMs 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.cacheMaxAgeMs 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 several providers with the backend.
*
* @param {Object} settings the arguments object for this function call
* @param {Array.} settings.globalDiscoveryEntries -
* A list which stores information about each provider instance
* that shall be registered with the backend.
GlobalDiscoveryEntry
*/
/**
* @function GlobalCapabilitiesDirectoryProxy#add
* @summary The add operation is GENERATED FROM THE INTERFACE DESCRIPTION
*
method overloading: different call semantics possible
*
Registers a single provider with the backend.
*
* @param {Object} settings the arguments object for this function call
* @param {GlobalDiscoveryEntry} settings.globalDiscoveryEntry -
* Information about the provider which shall be registered with
* the backend.
GlobalDiscoveryEntry
*/
this.add = new settings.proxyElementTypes.ProxyOperation(this, settings, "add", [
{
inputParameter: [
{
name : "globalDiscoveryEntries",
type : "joynr.types.GlobalDiscoveryEntry[]"
}
],
outputParameter: [
],
fireAndForget: false
}, {
inputParameter: [
{
name : "globalDiscoveryEntry",
type : "joynr.types.GlobalDiscoveryEntry"
}
],
outputParameter: [
],
fireAndForget: false
}
]).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 providers for a domain and an interface name. The domain
* and interface name correspond to the attributes stored in GlobalDiscoveryEntry.
* @see GlobalDiscoveryEntry
*
* @param {Object} settings the arguments object for this function call
* @param {Array.} settings.domains -
* Domain names for which providers shall be returned.
* @param {String} settings.interfaceName -
* The name of the requested provider interface.
* @returns {GlobalCapabilitiesDirectoryProxy#LookupReturned}
* {Array.} result
*/
/**
* @typedef {Object} GlobalCapabilitiesDirectoryProxy#LookupReturned
* @property {Array.} result
* Information about all providers which were found for the given
* domain and interface name.
*/
/**
* @function GlobalCapabilitiesDirectoryProxy#lookup
* @summary The lookup operation is GENERATED FROM THE INTERFACE DESCRIPTION
*
method overloading: different call semantics possible
*
Looks up a provider for a given participant Id.
*
* @param {Object} settings the arguments object for this function call
* @param {String} settings.participantId -
* The participant Id which identifies the requested provider.
* @returns {GlobalCapabilitiesDirectoryProxy#LookupReturned}
* {GlobalDiscoveryEntry} result
*/
/**
* @typedef {Object} GlobalCapabilitiesDirectoryProxy#LookupReturned
* @property {GlobalDiscoveryEntry} result
* Information about the found provider.
*/
this.lookup = new settings.proxyElementTypes.ProxyOperation(this, settings, "lookup", [
{
inputParameter: [
{
name : "domains",
type : "String[]"
},
{
name : "interfaceName",
type : "String"
}
],
outputParameter: [
{
name : "result",
type : "joynr.types.GlobalDiscoveryEntry[]"
}
],
fireAndForget: false
}, {
inputParameter: [
{
name : "participantId",
type : "String"
}
],
outputParameter: [
{
name : "result",
type : "joynr.types.GlobalDiscoveryEntry"
}
],
fireAndForget: false
}
]).buildFunction();
/**
* @function GlobalCapabilitiesDirectoryProxy#touch
* @summary The touch operation is GENERATED FROM THE INTERFACE DESCRIPTION
*
Updates the last seen date for a specific cluster controller.
*
* @param {Object} settings the arguments object for this function call
* @param {String} settings.clusterControllerId -
* Identifies the cluster controller for which the last
* seen date shall be updated.
*/
this.touch = new settings.proxyElementTypes.ProxyOperation(this, settings, "touch", [
{
inputParameter: [
{
name : "clusterControllerId",
type : "String"
}
],
outputParameter: [
],
fireAndForget: false
}
]).buildFunction();
/**
* @function GlobalCapabilitiesDirectoryProxy#remove
* @summary The remove operation is GENERATED FROM THE INTERFACE DESCRIPTION
*
method overloading: different call semantics possible
*
Unregisters providers from the backend.
*
* @param {Object} settings the arguments object for this function call
* @param {Array.} settings.participantIds -
* The participand Ids which identify the providers that shall be removed
* from the backend.
*/
/**
* @function GlobalCapabilitiesDirectoryProxy#remove
* @summary The remove operation is GENERATED FROM THE INTERFACE DESCRIPTION
*
method overloading: different call semantics possible
*
Unregisters a provider from the backend.
*
* @param {Object} settings the arguments object for this function call
* @param {String} settings.participantId -
* The participant Id which identifies the provider that shall be removed
* from the backend.
*/
this.remove = new settings.proxyElementTypes.ProxyOperation(this, settings, "remove", [
{
inputParameter: [
{
name : "participantIds",
type : "String[]"
}
],
outputParameter: [
],
fireAndForget: false
}, {
inputParameter: [
{
name : "participantId",
type : "String"
}
],
outputParameter: [
],
fireAndForget: false
}
]).buildFunction();
Object.defineProperty(this, "interfaceName", {
writable: false,
readable: true,
value: "infrastructure/GlobalCapabilitiesDirectory"
});
};
/**
* @name GlobalCapabilitiesDirectoryProxy#MAJOR_VERSION
* @constant {Number}
* @default 0
* @summary The MAJOR_VERSION of the proxy is GENERATED FROM THE INTERFACE DESCRIPTION
*/
Object.defineProperty(GlobalCapabilitiesDirectoryProxy, 'MAJOR_VERSION', {
enumerable: false,
configurable: false,
writable: false,
readable: true,
value: 0
});
/**
* @name GlobalCapabilitiesDirectoryProxy#MINOR_VERSION
* @constant {Number}
* @default 1
* @summary The MINOR_VERSION of the proxy is GENERATED FROM THE INTERFACE DESCRIPTION
*/
Object.defineProperty(GlobalCapabilitiesDirectoryProxy, 'MINOR_VERSION', {
enumerable: false,
configurable: false,
writable: false,
readable: true,
value: 1
});
GlobalCapabilitiesDirectoryProxy.getUsedDatatypes = function getUsedDatatypes(){
return [
"joynr.types.GlobalDiscoveryEntry"
];
};
// AMD support
if (typeof define === 'function' && define.amd) {
define("joynr/infrastructure/GlobalCapabilitiesDirectoryProxy", [
"joynr/types/GlobalDiscoveryEntry"
], function () {
return GlobalCapabilitiesDirectoryProxy;
});
} else if (typeof exports !== 'undefined' ) {
if ((module !== undefined) && module.exports) {
require("../../joynr/types/GlobalDiscoveryEntry");
exports = module.exports = GlobalCapabilitiesDirectoryProxy;
}
else {
// support CommonJS module 1.1.1 spec (`exports` cannot be a function)
exports.GlobalCapabilitiesDirectoryProxy = GlobalCapabilitiesDirectoryProxy;
}
} else {
window.GlobalCapabilitiesDirectoryProxy = GlobalCapabilitiesDirectoryProxy;
}
})();
© 2015 - 2025 Weber Informatics LLC | Privacy Policy