joynr.system.LoggingProxy.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
 *
 * LoggingProxy, generated from the corresponding interface description.
 */
(function (undefined){
	/**
	 * @name LoggingProxy
	 * @constructor
	 *
	 * @classdesc
	 * 
Generation date: Wed Jan 27 16:29:10 CET 2016
	 * 


	 * LoggingProxy, generated from the corresponding interface description.
	 * 

"The logging interface is implemented by log4j and
	 * log4javascript appenders. Do not use directly"
	 *
	 * @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 {LoggingProxy} a LoggingProxy object to access other providers
	 */
	var LoggingProxy = function LoggingProxy(
		settings) {
		if (!(this instanceof LoggingProxy)) {
			// in case someone calls constructor without new keyword (e.g. var c = Constructor({..}))
			return new LoggingProxy(
				settings);
		}

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


		/**
		 * @function LoggingProxy#log
		 * @summary The log operation is GENERATED FROM THE INTERFACE DESCRIPTION
		 * 

log a number of events
		 *
		 * @param {Array.} logEvents -
		 * The list of events to be logged
		 */
		this.log = new settings.proxyElementTypes.ProxyOperation(this, settings, "log", [
			{
				inputParameter: [
				{
					name : "logEvents",
					type : "joynr.system.JoynrLogEvent[]"
				}
				],
				outputParameter: [
				]
			}
		]).buildFunction();


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

	LoggingProxy.getUsedDatatypes = function getUsedDatatypes(){
		return [
					"joynr.system.JoynrLogEvent"
				];
	};

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