joynr.proxy.SubscriptionQos.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
/*
 * #%L
 * %%
 * Copyright (C) 2011 - 2015 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%
 */

define("joynr/proxy/SubscriptionQos", [
    "joynr/util/UtilInternal",
    "joynr/system/LoggerFactory"
], function(Util, LoggerFactory) {

    var defaultSettings;

    /**
     * @classdesc
     * Base class representing the subscription quality of service settings.
     * This class stores quality of service settings used for subscriptions to
     * attributes and broadcasts in generated proxy objects.

     * Subclasses are {@link PeriodicSubscriptionQos},
     * {@link OnChangeSubscriptionQos}, and
     * {@link OnChangeWithKeepAliveSubscriptionQos}.

     * The provider will send notifications until the expiry date is reached. The
     * subscription will automatically expire after the expiry date is reached.
     *
     * @summary
     * Constructor of SubscriptionQos object used for subscriptions to
     * attributes and events in generated proxy objects.
     *
     * @constructor
     * @name SubscriptionQos
     *
     * @param {Object}
     *            [settings] the settings object for the constructor call
     * @param {Number}
     *            [settings.expiryDate=0] The expiryDate is the end date of the
     *            subscription. This value is provided in milliseconds
     *            (since 1970-01-01T00:00:00.000).

     *            

     *            Minimum and Default Values:
     *            
     *              minimum value: {@link SubscriptionQos.MIN_EXPIRY}
     *              default value: {@link SubscriptionQos.NO_EXPIRY_DATE}
     *            
     * @param {Number}
     *            [settings.publicationTtl=10 000] Time to live for publication
     *            messages.

     *            

     *            If a notification message can not be delivered within its time
     *            to live, it will be deleted from the system. This value is
     *            provided in milliseconds.

     *            

     *            Minimum and Default Values:
     *            
     *              minimum value: {@link SubscriptionQos.MIN_PUBLICATION_TTL}
     *              default value: {@link SubscriptionQos.DEFAULT_PUBLICATION_TTL}
     *            
     *
     * @returns {SubscriptionQos}
     *            a subscription Qos Object for subscriptions on attributes
     *            and events
     */
    function SubscriptionQos(settings) {
        if (!(this instanceof SubscriptionQos)) {
            // in case someone calls constructor without new keyword (e.g. var c
            // = Constructor({..}))
            return new SubscriptionQos(settings);
        }

        var log = LoggerFactory.getLogger("joynr.proxy.SubscriptionQos");

        /**
         * Used for serialization.
         * @name SubscriptionQos#_typeName
         * @type String
         * @field
         */
        Util.objectDefineProperty(this, "_typeName", "joynr.SubscriptionQos");
        Util.checkPropertyIfDefined(settings, "Object", "settings");
        if (settings) {
            Util.checkPropertyIfDefined(settings.expiryDate, "Number", "settings.expiryDate");
            Util.checkPropertyIfDefined(
                    settings.publicationTtl,
                    "Number",
                    "settings.publicationTtl");
        }

        /**
         * See [constructor description]{@link SubscriptionQos}.
         * @name SubscriptionQos#expiryDate
         * @type Number
         * @field
         */
        /**
         * See [constructor description]{@link SubscriptionQos}.
         * @name SubscriptionQos#publicationTtl
         * @type Number
         * @field
         */
        Util.extend(this, defaultSettings, settings);
        if (this.publicationTtl < SubscriptionQos.MIN_PUBLICATION_TTL) {
            throw new Error("Wrong publicationttl with value "
                + this.publicationTtl
                + ": it shall be higher than "
                + SubscriptionQos.MIN_PUBLICATION_TTL);
        }

        if (this.expiryDate < SubscriptionQos.MIN_EXPIRY) {
            throw new Error("Wrong expiryDate with value "
                + this.expiryDate
                + ": it shall be higher than "
                + SubscriptionQos.MIN_EXPIRY);
        }
    }

    /**
     * Minimal value for [publicationTtl]{@link SubscriptionQos#publicationTtl}.
     * See [constructor description]{@link SubscriptionQos}.
     *
     * @name SubscriptionQos.MIN_PUBLICATION_TTL
     * @type Number
     * @default 100
     * @static
     * @readonly
     */
    SubscriptionQos.MIN_PUBLICATION_TTL = 100;
    /**
     * Minimal value for [expiryDate]{@link SubscriptionQos#expiryDate} in milliseconds
     * (0 secs). See [constructor description]{@link SubscriptionQos}.
     *
     * @name SubscriptionQos.MIN_EXPIRY
     * @type Number
     * @default 0
     * @static
     * @readonly
     */
    SubscriptionQos.MIN_EXPIRY = 0;
    /**
     * Default value for [expiryDate]{@link SubscriptionQos#expiryDate} in milliseconds
     * (no expiry date). See [constructor description]{@link SubscriptionQos}.
     *
     * @name SubscriptionQos.NO_EXPIRY_DATE
     * @type Number
     * @default 0
     * @static
     * @readonly
     */
    SubscriptionQos.NO_EXPIRY_DATE = 0;
    /**
     * @name SubscriptionQos.NO_EXPIRY_DATE_TTL
     * @type Number
     * @default Util.getMaxLongValue()
     * @static
     * @readonly
     */
    SubscriptionQos.NO_EXPIRY_DATE_TTL = Util.getMaxLongValue();
    /**
     * Default value for [publicationTtl]{@link SubscriptionQos#publicationTtl} in
     * milliseconds (10 secs). See [constructor description]{@link SubscriptionQos}.
     *
     * @name SubscriptionQos.DEFAULT_PUBLICATION_TTL
     * @type Number
     * @default 10 000
     * @static
     * @readonly
     */
    SubscriptionQos.DEFAULT_PUBLICATION_TTL = 10000;

    defaultSettings = {
        expiryDate : SubscriptionQos.NO_EXPIRY_DATE,
        publicationTtl : SubscriptionQos.DEFAULT_PUBLICATION_TTL
    };

    return SubscriptionQos;

});