Class PubSubSystem<AD, I, O>

constructor

• new PubSubSystem<AD, I, O>(options?): PubSubSystem<AD, I, O>

• Type Parameters

  • AD extends ITopicSetContentOptions & {
        pubSubUpdate?: boolean;
    } = ITopicSetContentOptions

  • I extends INopeEventEmitter<unknown, unknown, unknown, AD, I> = INopeEventEmitter<unknown, unknown, unknown, AD>

  • O extends INopeEventEmitter<any, any, any, ITopicSetContentOptions, O> = INopeTopic<any, any, any>

  Parameters

  • options: Partial<IPubSubOptions> & {
        generateEmitterType?: (() => I);
    } = {}

  Returns PubSubSystem<AD, I, O>

_options

Readonly onIncrementalDataChange

// Describe the required Test:
let pubSubSystem = new PubSubSystemBase({
  generateEmitterType: function () {
    return new NopeEventEmitter() as INopeEventEmitter;
  },
});


// Create a Publisher for the system:
let publisher: INopeEventEmitter = new NopeEventEmitter();

pubSubSystem.register(publisher, {
  mode: "publish",
  schema: {},
  topic: "this/is/a/test",
});


pubSubSystem.onIncrementalDataChange.subscribe(console.log);
publisher.emit("Hello World!"); // Logs the following => {path: "this/is/a/test", data: "Hello World!"}

Readonly publishers

Readonly subscriptions

emitters

• get emitters(): {
      publishers: {
          name: string;
          schema: INopeDescriptor;
      }[];
      subscribers: {
          name: string;
          schema: INopeDescriptor;
      }[];
  }

• List all known Emitters in the System.

  Returns {
      publishers: {
          name: string;
          schema: INopeDescriptor;
      }[];
      subscribers: {
          name: string;
          schema: INopeDescriptor;
      }[];
  }

  • publishers: {
        name: string;
        schema: INopeDescriptor;
    }[]

  • subscribers: {
        name: string;
        schema: INopeDescriptor;
    }[]

options

• get options(): IPubSubOptions

• Options which describe the Behavior

  Author

  M.Karkowski

  Memberof

  IPubSubSystem

  Returns IPubSubOptions

dispose

• dispose(): void

• Unregisters all Emitters and removes all subscriptions of the "onIncrementalDataChange", "publishers" and "subscriptions"

  Author

  M.Karkowski

  Memberof

  PubSubSystemBase

  Returns void

emit

• emit(eventName, data, options?): void

• Helper, to update the Matching. But, we are just considering

  Parameters

  • eventName: string

  • data: any

  • Optional options: AD

  Returns void

register

• register(emitter, options): O

• Function to register an Observable. Please define the Options, to decide whether the data of the observable should be published or subscribed.

  Author

  M.Karkowski

  Returns

  {O}

  Memberof

  IPubSubSystem

  Parameters

  • emitter: I

    The Emitter to consider

  • options: IEventOptions

  Returns O

registerSubscription

• registerSubscription<T>(topic, subscription): INopeObserver

• A Helper, that allows the user to subscribe to changes. Therfore he must transmit

  Author

  M.Karkowski

  Returns

  {INopeObserver}

  Memberof

  IPubSubSystem

  Type Parameters

  • T = unknown

    Expected Type of the content

  Parameters

  • topic: string

    The

  • subscription: IEventCallback<T, AD>

  Returns INopeObserver

toDescription

• toDescription(): {
      publishers: {
          name: string;
          schema: INopeDescriptor;
      }[];
      subscribers: {
          name: string;
          schema: INopeDescriptor;
      }[];
  }

• Describes the Data.

  Returns

  Returns {
      publishers: {
          name: string;
          schema: INopeDescriptor;
      }[];
      subscribers: {
          name: string;
          schema: INopeDescriptor;
      }[];
  }

  • publishers: {
        name: string;
        schema: INopeDescriptor;
    }[]

  • subscribers: {
        name: string;
        schema: INopeDescriptor;
    }[]

unregister

• unregister(emitter): boolean

• Removes an observable of the Pub-Sub-System.

  Author

  M.Karkowski

  Returns

  {boolean}

  Memberof

  IPubSubSystem

  Parameters

  • emitter: I

  Returns boolean

updateMatching

• updateMatching(): void

• Internal Match-Making Algorithm. This allowes to Create a predefined List between Publishers and Subscribers. Thereby the Process is speed up, by utilizing this Look-Up-Table

  Author

  M.Karkowski

  Memberof

  PubSubSystemBase

  Returns void

updateOptions

• updateOptions(emitter, options): void

• Function to update the options and there by the topics of an observable.

  Author

  M.Karkowski

  Memberof

  IPubSubSystem

  Parameters

  • emitter: I

    The Emitter to consider

  • options: IEventOptions

    The modified options

  Returns void