API Docs for: 0.0.57
Show:

ServerSidePublishEngine Class

Constructor

ServerSidePublishEngine

(
  • options
)

Parameters:

  • options Object
    • [maxPublishRequestInQueue= 100] Integer optional

Methods

add_subscription

(
  • subscription
)

Parameters:

getSubscriptionById

(
  • subscriptionId
)
Subscription

retrieve a subscription by id.

Parameters:

  • subscriptionId Integer

Returns:

send_keep_alive_response

(
  • subscriptionId
  • future_sequence_number
)
Boolean

call by a subscription when no notification message is available after the keep alive delay has expired.

Parameters:

  • subscriptionId Object
  • future_sequence_number Object

Returns:

Boolean:

true if a publish response has been sent

send_notification_message

(
  • param
  • force
)
private

Parameters:

  • param Object
    • subscriptionId Number
    • sequenceNumber Number
    • notificationData Object
    • availableSequenceNumbers Array
    • moreNotifications Boolean
  • force Boolean

    push response in queue until next publish Request is received

Properties

pendingPublishRequestCount

Integer

number of pending PublishRequest available in queue

subscription

Subscription[]

get a array of subscription handled by the publish engine.

subscriptionCount

Integer

number of subscriptions