aes70/src/controller/ControlClasses/OcaSubscriptionManager.d.ts

A controller library for the AES70 protocol.

import { IOcaEvent } from '../../types/OcaEvent';
import { IOcaMethod } from '../../types/OcaMethod';
import { IOcaNotificationDeliveryMode } from '../../types/OcaNotificationDeliveryMode';
import { IOcaPropertyID } from '../../types/OcaPropertyID';
import { OcaSubscriptionManagerState } from '../../types/OcaSubscriptionManagerState';
import { Event } from '../event';
import { PropertyEvent } from '../property_event';
import { RemoteDevice } from '../remote_device';
import { OcaManager } from './OcaManager';

/**
 * Manager that collects and controls the event subscriptions of the device.
 *
 *  - Must be instantiated once in every device that supports subscriptions.
 *
 *  - May be instantiated at most once in any device.
 *
 *  - If instantiated, must have object number 4.
 *
 *
 * Absence of an **OcaSubscriptionManager** object signifies that the device
 * does not support event subscriptions.
 * @extends OcaManager
 * @class OcaSubscriptionManager
 */
export declare class OcaSubscriptionManager extends OcaManager {
  /**
   * Event that is raised when the value of the **State** property changes from
   * **Normal **to **EventsDisabled.**
   * @member OcaSubscriptionManager#OnNotificationsDisabled {Event}
   */
  OnNotificationsDisabled: Event;

  /**
   * Event that is raised when the value of the **State** property changes from
   * **EventsDisabled **to **Normal.** Event data includes a lists of which
   * objects changed state during the period that notifications were disabled.
   * @member OcaSubscriptionManager#OnSynchronizeState {Event}
   */
  OnSynchronizeState: Event;
  /**
   * This event is emitted whenever State changes.
   */
  OnStateChanged: PropertyEvent<OcaSubscriptionManagerState>;

  constructor(objectNumber: number, device: RemoteDevice);

  /**
   * Adds a subscription to an event. The subscription is added for the session
   * on which the command came in. If a subscription identical to the one being
   * requested already exists, an additional one shall not be added. Two
   * subscriptions are identical if the **Event, Subscriber,
   * NotificationDeliveryMode**, and **DestinationInformation** parameters are
   * all identical. The return value indicates whether the subscription
   * succeeded.
   *
   * @method OcaSubscriptionManager#AddSubscription
   * @param {IOcaEvent} Event
   * @param {IOcaMethod} Subscriber
   * @param {Uint8Array} SubscriberContext
   * @param {IOcaNotificationDeliveryMode} NotificationDeliveryMode
   * @param {Uint8Array} DestinationInformation
   *
   * @returns {Promise<void>}
   */
  AddSubscription(
    Event: IOcaEvent,
    Subscriber: IOcaMethod,
    SubscriberContext: Uint8Array,
    NotificationDeliveryMode: IOcaNotificationDeliveryMode,
    DestinationInformation: Uint8Array
  ): Promise<void>;

  /**
   * Removes all subscriptions to the given event with the given **OcaMethod**.
   * The return value indicates whether the subscription(s) was (were)
   * successfully removed.
   *
   * @method OcaSubscriptionManager#RemoveSubscription
   * @param {IOcaEvent} Event
   * @param {IOcaMethod} Subscriber
   *
   * @returns {Promise<void>}
   */
  RemoveSubscription(Event: IOcaEvent, Subscriber: IOcaMethod): Promise<void>;

  /**
   * Temporarily disables emitting of event notifications (to all subscribers,
   * not just to the subscriber calling this method). Events from the
   * Subscription Manager itself are not disabled. This method can be used if
   * either a controller or the local device knows that it is going to change
   * the state of the device significantly, which could lead to a notification
   * storm of events. Invoking this method will prevent the notification storm.
   * The event '03e01 EventsDisabled' will be raised to notify all controllers
   * of the fact that events are temporarily disabled. The subscription manager
   * will start collecting the object numbers of the objects that raise events,
   * so that it can pass a list of changed objects once the events are
   * re-enabled. The return value indicates if disabling events succeeded.
   *
   * @method OcaSubscriptionManager#DisableNotifications
   * @returns {Promise<void>}
   */
  DisableNotifications(): Promise<void>;

  /**
   * Re-enables the sending of event notifications to all subscribers. When
   * events are re-enabled, the subscription manager will raise the
   * **SynchronizeState** event, passing the list of objects that have changed
   * state. Subsequently, the subscription manager will transmit all
   * notifications as normal. If the connection to the controller that invoked
   * the DisableEvents() is lost, this method will be called automatically to
   * prevent the situation in which the raising of events would never be
   * re-enabled. The return value indicates if re-enabling the event-based
   * events succeeded.
   *
   * @method OcaSubscriptionManager#ReEnableNotifications
   * @returns {Promise<void>}
   */
  ReEnableNotifications(): Promise<void>;

  /**
   * Adds a subscription to the PropertyChanged event in the object Emitter for
   * changes of the property Property. If the NotificationDeliveryMode is Fast,
   * the subscription is added for the session on which the command came in. If
   * a subscription identical to the one being requested already exists, an
   * additional one shall not be added. Two subscriptions are identical if the
   * Emitter, Property, Subscriber, SubsciberContext, NotificationDeliveryMode,
   * and DestinationInformation parameters are all identical. The return value
   * indicates whether the subscription succeeded. Added in v2 of this class, in
   * AES70-2017.
   *
   * @method OcaSubscriptionManager#AddPropertyChangeSubscription
   * @param {number} Emitter
   * @param {IOcaPropertyID} Property
   * @param {IOcaMethod} Subscriber
   * @param {Uint8Array} SubscriberContext
   * @param {IOcaNotificationDeliveryMode} NotificationDeliveryMode
   * @param {Uint8Array} DestinationInformation
   *
   * @returns {Promise<void>}
   */
  AddPropertyChangeSubscription(
    Emitter: number,
    Property: IOcaPropertyID,
    Subscriber: IOcaMethod,
    SubscriberContext: Uint8Array,
    NotificationDeliveryMode: IOcaNotificationDeliveryMode,
    DestinationInformation: Uint8Array
  ): Promise<void>;

  /**
   * Removes any subscription to a PropertyChanged event with the given Emitter,
   * Property, Subscriber, SubscriberContext, NotificationDeliveryMode, and
   * DestinationInformation. The return value indicates whether the
   * subscription(s) was (were) successfully removed. Added in v2 of this class,
   * in AES70-2017.
   *
   * @method OcaSubscriptionManager#RemovePropertyChangeSubscription
   * @param {number} Emitter
   * @param {IOcaPropertyID} Property
   * @param {IOcaMethod} Subscriber
   *
   * @returns {Promise<void>}
   */
  RemovePropertyChangeSubscription(
    Emitter: number,
    Property: IOcaPropertyID,
    Subscriber: IOcaMethod
  ): Promise<void>;

  /**
   * Returns maximum byte length of payload of subscriber context parameter that
   * this device supports. This returned value shall be either zero or four. If
   * the returned payload length is not zero, it shall be four. No other values
   * shall be allowed, and the returned value shall not change once the device
   * has initialized. NOTE: In AES70-2015, arbitrary subscriber context lengths
   * were allowed; this is no longer true.
   *
   * @method OcaSubscriptionManager#GetMaximumSubscriberContextLength
   * @returns {Promise<number>}
   *   A promise which resolves to a single value of type ``number``.
   */
  GetMaximumSubscriberContextLength(): Promise<number>;
}