Class Subscription

constructor

• new Subscription(
      onvif: Onvif,
      options?: CreatePullPointSubscriptionExtended,
  ): Subscription

  Parameters

  • onvif: Onvif
  • options: CreatePullPointSubscriptionExtended = {}

  Returns Subscription

connectionError

eventReconnectMs

Optionalsubscription

eventPull

• eventPull(): Promise<void>

  Loop events from the subscription

  Returns Promise<void>

pullMessages

• pullMessages(
      options?: Partial<PullMessages> & { signal?: AbortSignal },
  ): Promise<PullMessagesResponse>

  Pull messages from the subscription (long-poll).

  Parameters

  • Optionaloptions: Partial<PullMessages> & { signal?: AbortSignal }

    ONVIF PullMessages fields, plus optional signal to cancel the HTTP request before the device Timeout elapses (see innerDocs/events.md).

  Returns Promise<PullMessagesResponse>

  Example: Abort a one-minute pull after 5 seconds:

  const ac = new AbortController();
  const timer = setTimeout(() => ac.abort(), 5000);
  try {
    const { notificationMessage } = await sub.pullMessages({
      timeout: 'PT1M',
      signal: ac.signal,
    });
  } catch (err) {
    if (!(err instanceof Error) || err.name !== 'AbortError') throw err;
    // cancelled
  } finally {
    clearTimeout(timer);
  }
  Copy

renew

• renew(): Promise<TerminationTimeResponse>

  Renew the subscription

  Returns Promise<TerminationTimeResponse>

setSynchronizationPoint

• setSynchronizationPoint(): Promise<void>

  Properties inform a client about property creation, changes and deletion in a uniform way. When a client wants to synchronize its properties with the properties of the device, it can request a synchronization point which repeats the current status of all properties to which a client has subscribed. The PropertyOperation of all produced notifications is set to “Initialized”. The Synchronization Point is requested directly from the SubscriptionManager which was returned in either the SubscriptionResponse or in the CreatePullPointSubscriptionResponse. The property update is transmitted via the notification transportation of the notification interface. This method is mandatory.

  Returns Promise<void>

subscribe

• subscribe(): Promise<void>

  Create a pull-point subscription and start the background eventPull loop.

  Returns Promise<void>

unsubscribe

• unsubscribe(resetAgent?: boolean): Promise<void>

  The device shall provide the following Unsubscribe command for all SubscriptionManager endpoints returned by the CreatePullPointSubscription command. This command shall terminate the lifetime of a pull point.

  Parameters

  • resetAgent: boolean = true

    if we want to abort long-pulling connections, default true

  Returns Promise<void>

data

error