API Docs for: 0.0.57
Show:

ClientSidePublishEngine Class

A client side implementation to deal with publish service.

Constructor

ClientSidePublishEngine

(
  • session
)

Parameters:

Methods

acknowledge_notification

(
  • subscriptionId
  • sequenceNumber
)

Parameters:

  • subscriptionId Number

    the subscription id

  • sequenceNumber Number

    the sequence number

getSubscription

(
  • subscriptionId
)
Subscription | Null

get the client subscription from Id

Parameters:

  • subscriptionId Number

    the subscription Id

Returns:

Subscription | Null:

registerSubscription

(
  • subscription.subscriptionId
  • subscription.timeoutHint
  • subscription.onNotificationMessage
)

Parameters:

  • subscription.subscriptionId Object
  • subscription.timeoutHint Object
  • subscription.onNotificationMessage Function

    callback

send_publish_request

()

unregisterSubscription

(
  • subscriptionId
)

Parameters:

  • subscriptionId Object

Properties

subscriptionCount

Number

the number of active subscriptions managed by this publish engine.