NatsConnection

NATS connection using the default driver.

Implements: IMessageQueueConnection, IReferenceable, IConfigurable, IOpenable

Description

The NatsConnection class is used to define NATS connections using the default driver.

Important points

  • By defining a connection and sharing it through multiple message queues, you can reduce number of used database connections.

Configuration parameters

  • client_id: (optional) name of the client id
  • connection(s):
    • discovery_key: (optional) key to retrieve the connection from IDiscovery
    • host: host name or IP address
    • port: port number (default: 27017)
    • uri: resource URI or connection string with all parameters in it
  • credential(s):
    • store_key: (optional) key to retrieve the credentials from ICredentialStore
    • username: username
    • password: user’s password
  • options:
    • retry_connect: (optional) turns on/off automated reconnect when the connection is lost (default: true)
    • max_reconnect: (optional) maximum number of reconnection attempts (default: 3)
    • reconnect_timeout: (optional) number of milliseconds to wait on each reconnection attempt (default: 3000)
    • flush_timeout: (optional) number of milliseconds to wait on flushing messages (default: 3000)

References

  • *:logger:*:*:1.0 - (optional) ILogger components to pass log messages
  • *:discovery:*:*:1.0 - (optional) IDiscovery services
  • *:credential-store:*:*:1.0 (optional) credential stores to resolve credentials

Constructors

Creates a new instance of the connection component.

public constructor()

Fields

_clientId

Hostname as client id.

protected _clientId: string

_connection

NATS connection pool object.

protected _connection: any

_connectionResolver

Connection resolver.

protected _connectionResolver: NatsConnectionResolver

_flushTimeout

Number of milliseconds to wait on flushing messages (default: 3000)

protected _flushTimeout: number = 3000

_logger

Logger

protected _logger: CompositeLogger = new CompositeLogger()

_maxReconnect

Maximum number of reconnection attempts (default: 3)

protected _maxReconnect: number = 3

_options

Connection options

protected _options: ConfigParams = new ConfigParams()

_reconnectTimeout

Number of milliseconds to wait on each reconnection attempt (default: 3000)

protected _reconnectTimeout: number = 3000

_retryConnect

Retry to connect option

protected _retryConnect: boolean = true

_subscriptions

Topic subscriptions

protected _subscriptions: NatsSubscription[] = []

Instance methods

checkOpen

Checks if the connection is open.
Raises an error if the connection is closed.

protected checkOpen(): void

close

Closes a component and frees used resources.

public close(correlationId: string): Promise<void>

  • correlationId: string - (optional) transaction id used to trace execution through the call chain.

configure

Configures the component by passing its configuration parameters.

public configure(config: ConfigParams): void

  • config: ConfigParams - configuration parameters to be set.

createQueue

Creates a message queue. If the connection doesn’t support this function, it exists without error.

public createQueue(name: string): Promise<void>

  • name: string - name of the queue to be created.

deleteQueue

Deletes a message queue. If connection doesn’t support this function, it exists without error.

public deleteQueue(name: string): Promise<void>

  • name: string - name of the queue to be deleted.

getConnection

Gets the connection.

public getConnection(): any

  • returns: any - connection to NATS

isOpen

Checks if the component is open.

public isOpen(): boolean

  • returns: boolean - true if the component is open and false otherwise.

open

Opens the component.

public open(correlationId: string): Promise<void>

  • correlationId: string - (optional) transaction id used to trace execution through the call chain.

publish

Publishes a message to a specified topic.

public publish(subject: string, message: any): Promise<void>

  • subject: string - subject(topic) where the message will be placed
  • message: any - message to be published

readQueueNames

Reads a list of registered queue names. If the connection doesn’t support this function, it returns an empty list.

public readQueueNames(): Promise<string[]>

  • returns: Promise<string[]> - queue names.

setReferences

Sets references to dependent components.

public setReferences(references: IReferences): void

  • references: IReferences - references to locate the component’s dependencies.

subscribe

Subscribes to a topic.

public subscribe(subject: string, options: any, listener: INatsMessageListener): Promise<void>

  • subject: string - subject(topic) name
  • options: any - subscription options
  • listener: INatsMessageListener - message listener

unsubscribe

Unsubscribes from a previously subscribed topic.

public unsubscribe(subject: string, listener: INatsMessageListener): Promise<void>