IMessageQueue | pip-services-messaging-node

Interface for asynchronous message queues.

Not all queues may implement all the methods. Attempt to call non-supported method will result in NotImplemented exception. To verify if specific method is supported consult with MessagingCapabilities.

see: [[MessageEnvelop]]
see: MessagingCapabilities

Hierarchy

IOpenable
IClosable
- IMessageQueue

Implemented by

Index

Methods

abandon

abandon(message: MessageEnvelope, callback?: function): void

- Defined in queues/IMessageQueue.ts:119
Returnes message into the queue and makes it available for all subscribers to receive it again. This method is usually used to return a message which could not be processed at the moment to repeat the attempt. Messages that cause unrecoverable errors shall be removed permanently or/and send to dead letter queue.

Parameters
- message: MessageEnvelope
  
  a message to return.
- Optional callback: function
  
  (optional) callback function that receives an error or null for success.
  - - (err: any): void
    - Parameters
      - err: any
      Returns void
Returns void

beginListen

beginListen(correlationId: string, receiver: IMessageReceiver): void

- Defined in queues/IMessageQueue.ts:149
Listens for incoming messages without blocking the current thread.

see

listen

see

IMessageReceiver

Parameters
- correlationId: string
  
  (optional) transaction id to trace execution through call chain.
- receiver: IMessageReceiver
  
  a receiver to receive incoming messages.
Returns void

close

close(correlationId: string, callback?: function): void

Inherited from IClosable.close

Overrides IClosable.close
- Defined in D:/Work/Project/Node.js/documentation/pip-services-messaging-node/node_modules/pip-services-commons-node/obj/src/run/IClosable.d.ts:14
Abstract method that will contain the logic for closing a component, disconnecting it from other services, and disposing resources.

Parameters
- correlationId: string
  
  unique business transaction id to trace calls across components.
- Optional callback: function
  
  the function to call when the closing process is complete. It will be called with an error if one is raised.
  - - (err: any): void
    - Parameters
      - err: any
      Returns void
Returns void

complete

complete(message: MessageEnvelope, callback?: function): void

- Defined in queues/IMessageQueue.ts:108
Permanently removes a message from the queue. This method is usually used to remove the message after successful processing.

Parameters
- message: MessageEnvelope
  
  a message to remove.
- Optional callback: function
  
  (optional) callback function that receives an error or null for success.
  - - (err: any): void
    - Parameters
      - err: any
      Returns void
Returns void

endListen

endListen(correlationId: string): void

- Defined in queues/IMessageQueue.ts:157
Ends listening for incoming messages. When this method is call listen unblocks the thread and execution continues.

Parameters
- correlationId: string
  
  (optional) transaction id to trace execution through call chain.
Returns void

getCapabilities

getCapabilities(): MessagingCapabilities

- Defined in queues/IMessageQueue.ts:32
Gets the queue capabilities

Returns MessagingCapabilities

the queue's capabilities object.

getName

getName(): string

- Defined in queues/IMessageQueue.ts:25
Gets the queue name

Returns string

the queue name.

isOpen

isOpen(): boolean

Inherited from IOpenable.isOpen
- Defined in D:/Work/Project/Node.js/documentation/pip-services-messaging-node/node_modules/pip-services-commons-node/obj/src/run/IOpenable.d.ts:13
Abstract method that will contain the logic for checking whether or not a component has been opened.

Returns boolean

true if the component has been opened and false otherwise.

listen

listen(correlationId: string, receiver: IMessageReceiver): void

- Defined in queues/IMessageQueue.ts:138
Listens for incoming messages and blocks the current thread until queue is closed.

see

IMessageReceiver

see

receive

Parameters
- correlationId: string
  
  (optional) transaction id to trace execution through call chain.
- receiver: IMessageReceiver
  
  a receiver to receive incoming messages.
Returns void

moveToDeadLetter

moveToDeadLetter(message: MessageEnvelope, callback?: function): void

- Defined in queues/IMessageQueue.ts:127
Permanently removes a message from the queue and sends it to dead letter queue.

Parameters
- message: MessageEnvelope
  
  a message to be removed.
- Optional callback: function
  
  (optional) callback function that receives an error or null for success.
  - - (err: any): void
    - Parameters
      - err: any
      Returns void
Returns void

open

open(correlationId: string, callback?: function): void

Inherited from IOpenable.open
- Defined in D:/Work/Project/Node.js/documentation/pip-services-messaging-node/node_modules/pip-services-commons-node/obj/src/run/IOpenable.d.ts:22
Abstract method that will contain the logic for opening a component and establishing connections to other services.

Parameters
- correlationId: string
  
  unique business transaction id to trace calls across components.
- Optional callback: function
  
  the function to call when the opening process is complete. It will be called with an error if one is raised.
  - - (err: any): void
    - Parameters
      - err: any
      Returns void
Returns void

peek

peek(correlationId: string, callback: function): void

- Defined in queues/IMessageQueue.ts:70
Peeks a single incoming message from the queue without removing it. If there are no messages available in the queue it returns null.

Parameters
- correlationId: string
  
  (optional) transaction id to trace execution through call chain.
- callback: function
  
  callback function that receives a message or error.
  - - (err: any, result: MessageEnvelope): void
    - Parameters
      - err: any
      - result: MessageEnvelope
      Returns void
Returns void

peekBatch

peekBatch(correlationId: string, messageCount: number, callback: function): void

- Defined in queues/IMessageQueue.ts:80
Peeks multiple incoming messages from the queue without removing them. If there are no messages available in the queue it returns an empty list.

Parameters
- correlationId: string
  
  (optional) transaction id to trace execution through call chain.
- messageCount: number
  
  a maximum number of messages to peek.
- callback: function
  
  callback function that receives a list with messages or error.
  - - (err: any, result: MessageEnvelope[]): void
    - Parameters
      - err: any
      - result: MessageEnvelope[]
      Returns void
Returns void

readMessageCount

readMessageCount(callback: function): void

- Defined in queues/IMessageQueue.ts:39
Reads the current number of messages in the queue to be delivered.

Parameters
- callback: function
  
  callback function that receives number of messages or error.
  - - (err: any, count: number): void
    - Parameters
      - err: any
      - count: number
      Returns void
Returns void

receive

receive(correlationId: string, waitTimeout: number, callback: function): void

- Defined in queues/IMessageQueue.ts:89
Receives an incoming message and removes it from the queue.

Parameters
- correlationId: string
  
  (optional) transaction id to trace execution through call chain.
- waitTimeout: number
  
  a timeout in milliseconds to wait for a message to come.
- callback: function
  
  callback function that receives a message or error.
  - - (err: any, result: MessageEnvelope): void
    - Parameters
      - err: any
      - result: MessageEnvelope
      Returns void
Returns void

renewLock

renewLock(message: MessageEnvelope, lockTimeout: number, callback?: function): void

- Defined in queues/IMessageQueue.ts:99
Renews a lock on a message that makes it invisible from other receivers in the queue. This method is usually used to extend the message processing time.

Parameters
- message: MessageEnvelope
  
  a message to extend its lock.
- lockTimeout: number
  
  a locking timeout in milliseconds.
- Optional callback: function
  
  (optional) callback function that receives an error or null for success.
  - - (err: any): void
    - Parameters
      - err: any
      Returns void
Returns void

send

send(correlationId: string, envelope: MessageEnvelope, callback?: function): void

- Defined in queues/IMessageQueue.ts:48
Sends a message into the queue.

Parameters
- correlationId: string
  
  (optional) transaction id to trace execution through call chain.
- envelope: MessageEnvelope
  
  a message envelop to be sent.
- Optional callback: function
  
  (optional) callback function that receives error or null for success.
  - - (err: any): void
    - Parameters
      - err: any
      Returns void
Returns void

sendAsObject

sendAsObject(correlationId: string, messageType: string, value: any, callback?: function): void

- Defined in queues/IMessageQueue.ts:61
Sends an object into the queue. Before sending the object is converted into JSON string and wrapped in a [[MessageEnvelop]].

see

send

Parameters
- correlationId: string
  
  (optional) transaction id to trace execution through call chain.
- messageType: string
  
  a message type
- value: any
  
  an object value to be sent
- Optional callback: function
  
  (optional) callback function that receives error or null for success.
  - - (err: any): void
    - Parameters
      - err: any
      Returns void
Returns void

Hierarchy

Implemented by

Index

Methods

Methods

abandon

Parameters

message: MessageEnvelope

Optional callback: function

Parameters

err: any

Returns void

Returns void

beginListen

Parameters

correlationId: string

receiver: IMessageReceiver

Returns void

close

Parameters

correlationId: string

Optional callback: function

Parameters

err: any

Returns void

Returns void

complete

Parameters

message: MessageEnvelope

Optional callback: function

Parameters

err: any

Returns void

Returns void

endListen

Parameters

correlationId: string

Returns void

getCapabilities

Returns MessagingCapabilities

getName

Returns string

isOpen

Returns boolean

listen

Parameters

correlationId: string

receiver: IMessageReceiver

Returns void

moveToDeadLetter

Parameters

message: MessageEnvelope

Optional callback: function

Parameters

err: any

Returns void

Returns void

open

Parameters

correlationId: string

Optional callback: function

Parameters

err: any

Returns void

Returns void

peek

Parameters

correlationId: string

callback: function

Parameters

err: any

result: MessageEnvelope

Returns void

Returns void

peekBatch

Parameters

correlationId: string

messageCount: number

callback: function

Parameters