joynr.system.RoutingProxy.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
Show all versions of libjoynr-js Show documentation
JOYnr JavaScript libjoynr-js
/**
* PLEASE NOTE: THIS IS A GENERATED FILE!
* Generation date: Fri Jun 29 14:35:22 CEST 2018
*
* RoutingProxy, generated from the corresponding interface description.
*/
(function (undefined){
/**
* @name RoutingProxy
* @constructor
*
* @classdesc
*
Generation date: Fri Jun 29 14:35:22 CEST 2018
*
* RoutingProxy, generated from the corresponding interface description.
*
The Routing interface is a joynr internal
* interface. joynr uses a hierarchy of MessageRouters to
* route messages from source to destination. The Routing
* interface is used to update routing information between parent and
* child MessageRouters.
*
* @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 {RoutingProxy} a RoutingProxy object to access other providers
*/
var RoutingProxy = function RoutingProxy(
settings) {
if (!(this instanceof RoutingProxy)) {
// in case someone calls constructor without new keyword (e.g. var c = Constructor({..}))
return new RoutingProxy(
settings);
}
// generated package name
this.settings = settings || {};
/**
* @name RoutingProxy#globalAddress
* @summary The globalAddress attribute is GENERATED FROM THE INTERFACE DESCRIPTION
*
global address of cluster-controller
* used for provider registration. Messages from global
* to these providers have to be sent to this address.
*/
this.globalAddress = new settings.proxyElementTypes.ProxyAttribute(this, settings, "globalAddress", "String","NOTIFYREAD");
/**
* @name RoutingProxy#replyToAddress
* @summary The replyToAddress attribute is GENERATED FROM THE INTERFACE DESCRIPTION
*
global address of cluster-controller
* used as replyTo address for outgoing requests.
* Replies from other cluster controllers have to be sent
* to this address.
*/
this.replyToAddress = new settings.proxyElementTypes.ProxyAttribute(this, settings, "replyToAddress", "String","NOTIFYREAD");
/**
* @function RoutingProxy#addNextHop
* @summary The addNextHop operation is GENERATED FROM THE INTERFACE DESCRIPTION
*
method overloading: different call semantics possible
*
Adds a hop to the parent routing table.
*
* The overloaded methods (one for each concrete Address type) is
* needed since polymorphism is currently not supported by joynr.
*
* @param {Object} settings the arguments object for this function call
* @param {String} settings.participantId -
* the ID of the target participant
* @param {ChannelAddress} settings.channelAddress -
* the messaging address of the next hop towards
* the corresponding participant ID
* @param {Boolean} settings.isGloballyVisible -
* true, participant is globally visible
* false, otherwise
*/
/**
* @function RoutingProxy#addNextHop
* @summary The addNextHop operation is GENERATED FROM THE INTERFACE DESCRIPTION
*
method overloading: different call semantics possible
*
Adds a hop to the parent routing table.
*
* The overloaded methods (one for each concrete Address type) is
* needed since polymorphism is currently not supported by joynr.
*
* @param {Object} settings the arguments object for this function call
* @param {String} settings.participantId -
* the ID of the target participant
* @param {MqttAddress} settings.mqttAddress -
* the messaging address of the next hop towards
* the corresponding participant ID
* @param {Boolean} settings.isGloballyVisible -
* true, participant is globally visible
* false, otherwise
*/
/**
* @function RoutingProxy#addNextHop
* @summary The addNextHop operation is GENERATED FROM THE INTERFACE DESCRIPTION
*
method overloading: different call semantics possible
*
Adds a hop to the parent routing table.
*
* The overloaded methods (one for each concrete Address type) is
* needed since polymorphism is currently not supported by joynr.
*
* @param {Object} settings the arguments object for this function call
* @param {String} settings.participantId -
* the ID of the target participant
* @param {BrowserAddress} settings.browserAddress -
* the messaging address of the next hop towards
* the corresponding participant ID
* @param {Boolean} settings.isGloballyVisible -
* true, participant is globally visible
* false, otherwise
*/
/**
* @function RoutingProxy#addNextHop
* @summary The addNextHop operation is GENERATED FROM THE INTERFACE DESCRIPTION
*
method overloading: different call semantics possible
*
Adds a hop to the parent routing table.
*
* The overloaded methods (one for each concrete Address type) is
* needed since polymorphism is currently not supported by joynr.
*
* @param {Object} settings the arguments object for this function call
* @param {String} settings.participantId -
* the ID of the target participant
* @param {WebSocketAddress} settings.webSocketAddress -
* the messaging address of the next hop towards
* the corresponding participant ID
* @param {Boolean} settings.isGloballyVisible -
* true, participant is globally visible
* false, otherwise
*/
/**
* @function RoutingProxy#addNextHop
* @summary The addNextHop operation is GENERATED FROM THE INTERFACE DESCRIPTION
*
method overloading: different call semantics possible
*
Adds a hop to the parent routing table.
*
* The overloaded methods (one for each concrete Address type) is
* needed since polymorphism is currently not supported by joynr.
*
* @param {Object} settings the arguments object for this function call
* @param {String} settings.participantId -
* the ID of the target participant
* @param {WebSocketClientAddress} settings.webSocketClientAddress -
* the messaging address of the next hop towards
* the corresponding participant ID
* @param {Boolean} settings.isGloballyVisible -
* true, participant is globally visible
* false, otherwise
*/
this.addNextHop = new settings.proxyElementTypes.ProxyOperation(this, settings, "addNextHop", [
{
inputParameter: [
{
name : "participantId",
type : "String",
javascriptType : "string"
},
{
name : "channelAddress",
type : "joynr.system.RoutingTypes.ChannelAddress",
javascriptType : "joynr.system.RoutingTypes.ChannelAddress"
},
{
name : "isGloballyVisible",
type : "Boolean",
javascriptType : "boolean"
}
],
outputParameter: [
],
fireAndForget: false
}, {
inputParameter: [
{
name : "participantId",
type : "String",
javascriptType : "string"
},
{
name : "mqttAddress",
type : "joynr.system.RoutingTypes.MqttAddress",
javascriptType : "joynr.system.RoutingTypes.MqttAddress"
},
{
name : "isGloballyVisible",
type : "Boolean",
javascriptType : "boolean"
}
],
outputParameter: [
],
fireAndForget: false
}, {
inputParameter: [
{
name : "participantId",
type : "String",
javascriptType : "string"
},
{
name : "browserAddress",
type : "joynr.system.RoutingTypes.BrowserAddress",
javascriptType : "joynr.system.RoutingTypes.BrowserAddress"
},
{
name : "isGloballyVisible",
type : "Boolean",
javascriptType : "boolean"
}
],
outputParameter: [
],
fireAndForget: false
}, {
inputParameter: [
{
name : "participantId",
type : "String",
javascriptType : "string"
},
{
name : "webSocketAddress",
type : "joynr.system.RoutingTypes.WebSocketAddress",
javascriptType : "joynr.system.RoutingTypes.WebSocketAddress"
},
{
name : "isGloballyVisible",
type : "Boolean",
javascriptType : "boolean"
}
],
outputParameter: [
],
fireAndForget: false
}, {
inputParameter: [
{
name : "participantId",
type : "String",
javascriptType : "string"
},
{
name : "webSocketClientAddress",
type : "joynr.system.RoutingTypes.WebSocketClientAddress",
javascriptType : "joynr.system.RoutingTypes.WebSocketClientAddress"
},
{
name : "isGloballyVisible",
type : "Boolean",
javascriptType : "boolean"
}
],
outputParameter: [
],
fireAndForget: false
}
]).buildFunction();
/**
* @function RoutingProxy#resolveNextHop
* @summary The resolveNextHop operation is GENERATED FROM THE INTERFACE DESCRIPTION
*
Asks the parent routing table whether it is able to
* resolve the destination participant ID.
*
* @param {Object} settings the arguments object for this function call
* @param {String} settings.participantId -
* the ID of the target participant to resolve
* @returns {RoutingProxy#ResolveNextHopReturned}
* {Boolean} resolved
*/
/**
* @typedef {Object} RoutingProxy#ResolveNextHopReturned
* @property {Boolean} resolved
* true, if the participant ID could be resolved
*/
this.resolveNextHop = new settings.proxyElementTypes.ProxyOperation(this, settings, "resolveNextHop", [
{
inputParameter: [
{
name : "participantId",
type : "String",
javascriptType : "string"
}
],
outputParameter: [
{
name : "resolved",
type : "Boolean",
javascriptType : "boolean"
}
],
fireAndForget: false
}
]).buildFunction();
/**
* @function RoutingProxy#removeNextHop
* @summary The removeNextHop operation is GENERATED FROM THE INTERFACE DESCRIPTION
*
Removes a hop from the parent routing table.
*
* @param {Object} settings the arguments object for this function call
* @param {String} settings.participantId -
* the ID of the target participant
*/
this.removeNextHop = new settings.proxyElementTypes.ProxyOperation(this, settings, "removeNextHop", [
{
inputParameter: [
{
name : "participantId",
type : "String",
javascriptType : "string"
}
],
outputParameter: [
],
fireAndForget: false
}
]).buildFunction();
/**
* @function RoutingProxy#addMulticastReceiver
* @summary The addMulticastReceiver operation is GENERATED FROM THE INTERFACE DESCRIPTION
*
Adds a new receiver via their participant ID to for the
* identified multicasts.
*
* @param {Object} settings the arguments object for this function call
* @param {String} settings.multicastId -
* the multicast ID the receiver is interested in.
* @param {String} settings.subscriberParticipantId -
* the participant ID of the receiver.
* @param {String} settings.providerParticipantId -
* the participant ID of the provider.
*/
this.addMulticastReceiver = new settings.proxyElementTypes.ProxyOperation(this, settings, "addMulticastReceiver", [
{
inputParameter: [
{
name : "multicastId",
type : "String",
javascriptType : "string"
},
{
name : "subscriberParticipantId",
type : "String",
javascriptType : "string"
},
{
name : "providerParticipantId",
type : "String",
javascriptType : "string"
}
],
outputParameter: [
],
fireAndForget: false
}
]).buildFunction();
/**
* @function RoutingProxy#removeMulticastReceiver
* @summary The removeMulticastReceiver operation is GENERATED FROM THE INTERFACE DESCRIPTION
*
Removes a new receiver via their participant ID to for the
* identified multicasts which was previously added via addMulticastReceiver.
*
* @param {Object} settings the arguments object for this function call
* @param {String} settings.multicastId -
* the multicast ID the receiver registered for.
* @param {String} settings.subscriberParticipantId -
* the participant ID of the receiver.
* @param {String} settings.providerParticipantId -
* the participant ID of the provider.
*/
this.removeMulticastReceiver = new settings.proxyElementTypes.ProxyOperation(this, settings, "removeMulticastReceiver", [
{
inputParameter: [
{
name : "multicastId",
type : "String",
javascriptType : "string"
},
{
name : "subscriberParticipantId",
type : "String",
javascriptType : "string"
},
{
name : "providerParticipantId",
type : "String",
javascriptType : "string"
}
],
outputParameter: [
],
fireAndForget: false
}
]).buildFunction();
Object.defineProperty(this, "interfaceName", {
value: "system/Routing"
});
};
/**
* @name RoutingProxy#MAJOR_VERSION
* @constant {Number}
* @default 0
* @summary The MAJOR_VERSION of the proxy is GENERATED FROM THE INTERFACE DESCRIPTION
*/
Object.defineProperty(RoutingProxy, 'MAJOR_VERSION', { value: 0});
/**
* @name RoutingProxy#MINOR_VERSION
* @constant {Number}
* @default 1
* @summary The MINOR_VERSION of the proxy is GENERATED FROM THE INTERFACE DESCRIPTION
*/
Object.defineProperty(RoutingProxy, 'MINOR_VERSION', { value: 1});
RoutingProxy.getUsedDatatypes = function getUsedDatatypes(){
return [
"joynr.system.RoutingTypes.WebSocketClientAddress",
"joynr.system.RoutingTypes.BrowserAddress",
"joynr.system.RoutingTypes.ChannelAddress",
"joynr.system.RoutingTypes.MqttAddress",
"joynr.system.RoutingTypes.WebSocketAddress"
];
};
require("../../joynr/system/RoutingTypes/WebSocketProtocol");
require("../../joynr/system/RoutingTypes/WebSocketClientAddress");
require("../../joynr/system/RoutingTypes/BrowserAddress");
require("../../joynr/system/RoutingTypes/ChannelAddress");
require("../../joynr/system/RoutingTypes/MqttAddress");
require("../../joynr/system/RoutingTypes/WebSocketAddress");
module.exports = RoutingProxy;
})();
© 2015 - 2025 Weber Informatics LLC | Privacy Policy