Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TopicControl

Topic control feature.

Provides methods to change and update the topic tree stored on the server.

Example:

// Get a reference to topic control feature
var topics = session.topics;

Hierarchy

  • TopicControl

Index

Methods

add

  • Add a topic to the server at a specific path. This returns a Result.

    The path should be a string. To express hierarchies, / can be used as a delimiter. This allows topics to be nested and grouped below each other. For example, session.topics.add('foo/bar'); creates the topic bar . A topic is not created at foo by this method.

    Each topic has a particular type, which constrains the kind of values that the topic will allow. This type can either be explicitly provided, or included as part of a TopicSpecification.

    Adding from topic type

    To directly specify the type of topic to create, provide a string path and a TopicType. Topics specified in this way are created with default topic properties, as described in TopicSpecification.

    Adding from topic specification

    TopicSpecifications allows the creation of topics of a particular type, along with additional properties that determine how the topic operates. For instance, you may wish to specify that a topic will validate values before publishing, or that it will only publish values instead of deltas.

    Operation results

    If the topic was added, or a topic already exists with the same path and specification, the operation will succeed. If there is a problem with adding the topic then the result will be rejected with an error.

    If any sessions have already subscribed to the same path that a topic is created for, they will receive a subscription event once the topic is added, and a value event with the initial value (if supplied).

    If the session is closed when calling this method, the returned result will be rejected.

    Failure

    If the operation fails a TopicAddFailReason is provided. Adding a topic may fail because the session has insufficient permissions; a topic already exists at the specified path; or certain mandatory TopicSpecification properties were missing

    Example:

    // Create a topic with a Topic Type
    session.topics.add('foo/binary', diffusion.topics.TopicType.BINARY);

    Example:

    // Create a topic with a TopicSpecification
    const TopicSpecification = diffusion.topics.TopicSpecification;
    var specification = new TopicSpecification(diffusion.topics.TopicType.JSON, {
        TopicSpecification.VALIDATE_VALUES : "true"
    });
    
    session.topics.add('foo/json', specification);

    Example:

    // Handle the add topic result
    session.topics.add('foo/bob', diffusion.topics.TopicType.JSON).then(function(result) {
        if (result.added) {
            console.log('Topic added');
        } else {
            console.log('A compatible topic already exists');
        }
    }, function(error) {
        console.log('Topic add failed: ', error);
    });

    Parameters

    Returns Result<TopicAddResult>

    a Result for this operation

addMissingTopicHandler

  • Register a MissingTopicHandler to handle requests for a branch of the topic tree.

    The provided handler is called when a client subscribes using a topic selector that matches no existing topics. This allows a control client to intercede when another session requests a topic that does not exist. The control client may create the topic, perform some other action, or do nothing, before allowing the client operation to proceed by calling proceed(). Alternatively, the control client can call cancel() to discard the request.

    A control client can register multiple handlers, but may only register a single handler for a given topic path. See MissingTopicHandler.onRegister. A handler will only be called for topic selectors with a path prefix that starts with or is equal to topicPath . If the path prefix matches multiple handlers, the one registered for the most specific (longest) topic path will be called.

    If the session is closed or the handler could not be registered, the returned Result will call its failure callback, and the handler's MissingTopicHandler.onClose or MissingTopicHandler.onError method will be called.

    Parameters

    Returns Result<void>

    a Result for this registration

remove

  • Remove one or more topics at the server.

    The topics to remove will depend upon the nature of the topic selector specified. If the selector does not have descendant pattern qualifiers (i.e. / or //), only those topics that exist at paths indicated by the selector will be removed and not their descendants. If a single / qualifier is specified, all descendants of the matching topic paths will be removed. If // is specified, all branches of the topic tree that match the selector (i.e topics at the selected paths and all descendants of the selected paths) will be removed.

    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.

    Example:

    // Remove the topic at 'foo/bar', leaving descendants
    session.topics.remove('>foo/bar');

    Example:

    // Remove the topic at 'foo/bar' and all descendants
    session.topics.remove('?foo/bar//');

    Parameters

    • selector: Array<string | TopicSelector>

      the selector specifying the topics to remove

    Returns Result<void>

    a Result for this operation

  • Parameters

    Returns Result<void>

removeWithSession

  • Register a deferred action to remove a branch of the topic tree when this session is closed.

    A removal action can be registered at any point in the topic tree, but can not be placed above or below existing registrations. An error event will be emitted if the server rejects the registration.

    When this session is closed, regardless of reason, this topic and all topics below it will be removed from the topic tree.

    Multiple sessions can request that the same branch be removed. If a branch has multiple registrations, then the marked topics will not be removed until all registered sessions have been closed.

    When registration is successful, the Result will call the success callback with an object representing the registration with the property function deregister that can be called at any point to remove this registered action. The deregistration function returns a new Result.

    If the session is closed when calling this method, the returned result will emit an error event.

    deprecated

    since 6.1

    The preferred method for automatic removal of topics is the REMOVAL topic property. To achieve the equivalent of this method the property can be specified as:-

    when this session closes remove "?topicPath//"

    To achieve a dependency upon more than one session, a condition specifying a principal name or some other session property can be used.

    This method will be removed in a future release.

    Example:

    // Remove all topics under 'foo'
    session.topics.removeWithSession('foo').then(
        function(registration) {
            // Registration complete
    
            // Deregister this action
            registration.deregister().then(
                function() {
                    // Deregistration complete
                },
                function(err) {
                    // Failure while deregistering
                }
            );
        },
        function(err) {
            // Could not register
        }
    );

    Parameters

    • topicPath: string

      the path of the topic tree to remove

    Returns Result<RemoveWithSessionResult>

    registration Result.