joynr.messaging.inprocess.InProcessMessagingSkeleton.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

/*jslint es5: true, nomen: true, node: true */
/*
 * #%L
 * %%
 * Copyright (C) 2011 - 2017 BMW Car IT GmbH
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

/**
 * @name InProcessMessagingSkeleton
 * @constructor
 */
function InProcessMessagingSkeleton() {}

/**
 * @name InProcessMessagingSkeleton#receiveMessage
 * @function
 *
 * @param {JoynrMessage} joynrMessage
 * @returns {Object} A+ promise object
 */
InProcessMessagingSkeleton.prototype.receiveMessage = function receiveMessage(joynrMessage) {
    return this._onReceive(joynrMessage);
};

/**
 * A setter for the callback function that will receive the incoming messages
 *
 * @name InProcessMessagingSkeleton#registerListener
 * @function
 *
 * @param {Function} newOnReceive the function that is called with the incoming JoynrMessage
 */
InProcessMessagingSkeleton.prototype.registerListener = function registerListener(newOnReceive) {
    this._onReceive = newOnReceive;
};

module.exports = InProcessMessagingSkeleton;