joynr.system.RoutingProvider.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: Thu Jul 06 08:39:56 CEST 2017
*/
(function(undefined){
var checkImpl = function() {
var missingInImplementation = [];
if (! this.globalAddress.check()) missingInImplementation.push("Attribute:globalAddress");
if (! this.replyToAddress.check()) missingInImplementation.push("Attribute:replyToAddress");
if (! this.addNextHop.checkOperation()) missingInImplementation.push("Operation:addNextHop");
if (! this.resolveNextHop.checkOperation()) missingInImplementation.push("Operation:resolveNextHop");
if (! this.removeNextHop.checkOperation()) missingInImplementation.push("Operation:removeNextHop");
if (! this.addMulticastReceiver.checkOperation()) missingInImplementation.push("Operation:addMulticastReceiver");
if (! this.removeMulticastReceiver.checkOperation()) missingInImplementation.push("Operation:removeMulticastReceiver");
return missingInImplementation;
};
/**
* @name RoutingProvider
* @constructor
*
* @classdesc
* PLEASE NOTE. THIS IS A GENERATED FILE!
*
Generation date: Thu Jul 06 08:39:56 CEST 2017
*
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.
*
* @summary Constructor of RoutingProvider object
*
* @param {Object} [implementation] the implementation of the provider
* @param {Object} [implementation.ATTRIBUTENAME] the definition of attribute implementation
* @param {Function} [implementation.ATTRIBUTENAME.set] the getter function with the
* signature "function(value){}" that stores the given attribute value
* @param {Function} [implementation.ATTRIBUTENAME.get] the getter function with the
* signature "function(){}" that returns the current attribute value
* @param {Function} [implementation.OPERATIONNAME] the operation function
* @param {Object} [implementation.EVENTNAME] the definition of the event implementation
*
* @returns {RoutingProvider} a RoutingProvider object to communicate with the joynr infrastructure
*/
var RoutingProvider = null;
RoutingProvider = function RoutingProvider(
passedImplementation,
dependencies
) {
if (!(this instanceof RoutingProvider)) {
// in case someone calls constructor without new keyword (e.g. var c = Constructor({..}))
return new RoutingProvider(
passedImplementation,
dependencies);
}
var implementation = passedImplementation || {};
// defining provider members
/**
* @name RoutingProvider#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 dependencies.ProviderAttributeNotifyRead
(this, implementation.globalAddress, "globalAddress", "String");
if (implementation.globalAddress) {
implementation.globalAddress.valueChanged = this.globalAddress.valueChanged;
}
/**
* @name RoutingProvider#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 dependencies.ProviderAttributeNotifyRead
(this, implementation.replyToAddress, "replyToAddress", "String");
if (implementation.replyToAddress) {
implementation.replyToAddress.valueChanged = this.replyToAddress.valueChanged;
}
/**
* @function RoutingProvider#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 RoutingProvider#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 RoutingProvider#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 {CommonApiDbusAddress} settings.commonApiDbusAddress -
* the messaging address of the next hop towards
* the corresponding participant ID
* @param {Boolean} settings.isGloballyVisible -
* true, participant is globally visible
* false, otherwise
*/
/**
* @function RoutingProvider#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 RoutingProvider#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 RoutingProvider#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 dependencies.ProviderOperation(this, implementation.addNextHop, "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"
}
],
error: {
type: "no error enumeration given"
},
outputParameter: [
]
},
{
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"
}
],
error: {
type: "no error enumeration given"
},
outputParameter: [
]
},
{
inputParameter: [
{
name : "participantId",
type : "String",
javascriptType : "string"
},
{
name : "commonApiDbusAddress",
type : "joynr.system.RoutingTypes.CommonApiDbusAddress",
javascriptType : "joynr.system.RoutingTypes.CommonApiDbusAddress"
},
{
name : "isGloballyVisible",
type : "Boolean",
javascriptType : "boolean"
}
],
error: {
type: "no error enumeration given"
},
outputParameter: [
]
},
{
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"
}
],
error: {
type: "no error enumeration given"
},
outputParameter: [
]
},
{
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"
}
],
error: {
type: "no error enumeration given"
},
outputParameter: [
]
},
{
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"
}
],
error: {
type: "no error enumeration given"
},
outputParameter: [
]
}
]);
/**
* @function RoutingProvider#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 {RoutingProvider#ResolveNextHopReturned}
* {Boolean} resolved
*/
/**
* @typedef {Object} RoutingProvider#ResolveNextHopReturned
* @property {Boolean} resolved
* true, if the participant ID could be resolved
*/
this.resolveNextHop = new dependencies.ProviderOperation(this, implementation.resolveNextHop, "resolveNextHop", [
{
inputParameter: [
{
name : "participantId",
type : "String",
javascriptType : "string"
}
],
error: {
type: "no error enumeration given"
},
outputParameter: [
{
name : "resolved",
type : "Boolean",
javascriptType : "boolean"
}
]
}
]);
/**
* @function RoutingProvider#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 dependencies.ProviderOperation(this, implementation.removeNextHop, "removeNextHop", [
{
inputParameter: [
{
name : "participantId",
type : "String",
javascriptType : "string"
}
],
error: {
type: "no error enumeration given"
},
outputParameter: [
]
}
]);
/**
* @function RoutingProvider#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 dependencies.ProviderOperation(this, implementation.addMulticastReceiver, "addMulticastReceiver", [
{
inputParameter: [
{
name : "multicastId",
type : "String",
javascriptType : "string"
},
{
name : "subscriberParticipantId",
type : "String",
javascriptType : "string"
},
{
name : "providerParticipantId",
type : "String",
javascriptType : "string"
}
],
error: {
type: "no error enumeration given"
},
outputParameter: [
]
}
]);
/**
* @function RoutingProvider#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 dependencies.ProviderOperation(this, implementation.removeMulticastReceiver, "removeMulticastReceiver", [
{
inputParameter: [
{
name : "multicastId",
type : "String",
javascriptType : "string"
},
{
name : "subscriberParticipantId",
type : "String",
javascriptType : "string"
},
{
name : "providerParticipantId",
type : "String",
javascriptType : "string"
}
],
error: {
type: "no error enumeration given"
},
outputParameter: [
]
}
]);
Object.defineProperty(this, 'checkImplementation', {
enumerable: false,
configurable: false,
writable: false,
value: checkImpl
});
this.interfaceName = "system/Routing";
return Object.freeze(this);
};
/**
* @name RoutingProvider#MAJOR_VERSION
* @constant {Number}
* @default 0
* @summary The MAJOR_VERSION of the provider is GENERATED FROM THE INTERFACE DESCRIPTION
*/
Object.defineProperty(RoutingProvider, 'MAJOR_VERSION', {
enumerable: false,
configurable: false,
writable: false,
readable: true,
value: 0
});
/**
* @name RoutingProvider#MINOR_VERSION
* @constant {Number}
* @default 1
* @summary The MINOR_VERSION of the provider is GENERATED FROM THE INTERFACE DESCRIPTION
*/
Object.defineProperty(RoutingProvider, 'MINOR_VERSION', {
enumerable: false,
configurable: false,
writable: false,
readable: true,
value: 1
});
// AMD support
if (typeof define === 'function' && define.amd) {
define("joynr/system/RoutingProvider", [
"joynr/system/RoutingTypes/WebSocketAddress",
"joynr/system/RoutingTypes/WebSocketProtocol",
"joynr/system/RoutingTypes/WebSocketClientAddress",
"joynr/system/RoutingTypes/CommonApiDbusAddress",
"joynr/system/RoutingTypes/BrowserAddress",
"joynr/system/RoutingTypes/MqttAddress",
"joynr/system/RoutingTypes/ChannelAddress"
], function () {
return RoutingProvider;
}
);
} else if (typeof exports !== 'undefined' ) {
if ((module !== undefined) && module.exports) {
require("../../joynr/system/RoutingTypes/WebSocketAddress");
require("../../joynr/system/RoutingTypes/WebSocketProtocol");
require("../../joynr/system/RoutingTypes/WebSocketClientAddress");
require("../../joynr/system/RoutingTypes/CommonApiDbusAddress");
require("../../joynr/system/RoutingTypes/BrowserAddress");
require("../../joynr/system/RoutingTypes/MqttAddress");
require("../../joynr/system/RoutingTypes/ChannelAddress");
exports = module.exports = RoutingProvider;
}
else {
// support CommonJS module 1.1.1 spec (`exports` cannot be a function)
exports.RoutingProvider = RoutingProvider;
}
} else {
window.RoutingProvider = RoutingProvider;
}
})();
© 2015 - 2025 Weber Informatics LLC | Privacy Policy