Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TopicNotificationRegistration

The TopicNotificationRegistration represents the registration state of the associated listener on the server.

The TopicNotificationRegistration provides operations to control which topic paths the listener will receive notifications for. It can also close the listener and remove it from the server.

Hierarchy

  • TopicNotificationRegistration

Index

Methods

close

  • close(err?: any): void
  • Request that the listener is unregistered from the server.

    Parameters

    • Optional err: any

    Returns void

deselect

  • Request to stop receiving notifications for all topics matched by the given selector.

    This function can take any number of arguments. Each argument can be a string or a TopicSelector. Alternatively, an array of strings and TopicSelectors can be passed as a single argument. At least one valid selector has to be specified.

    Parameters

    • selector: Array<string | TopicSelector>

      the selector to register

    Returns Result<void>

    a Result for this operation

  • Parameters

    Returns Result<void>

select

  • Request to receive notifications for all topics matched by the provided topic selector.

    This function can take any number of arguments. Each argument can be a string or a TopicSelector. Alternatively, an array of strings and TopicSelectors can be passed as a single argument. At least one valid selector has to be specified.

    throws

    an IllegalArgumentError if the selector could not be parsed

    throws

    a NullValueError if the selector is null or undefined

    Parameters

    • selector: Array<string | TopicSelector>

      the selector to register

    Returns Result<void>

    a Result for this operation

  • Parameters

    Returns Result<void>