Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AmqpReceiver

Interface used to consume AMQP message as a stream of message. Back pressure is implemented using AMQP credits.

Hierarchy

  • AmqpReceiver

Implements

  • any

Index

Methods

Methods

address

  • address(): string

  • The listened address.

    Returns string

close

  • close(): PromiseLike<void>
  • close(handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

  • Closes the receiver.

    Returns PromiseLike<void>

  • Closes the receiver.

    Parameters

    • handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

    Returns void

connection

  • Gets the connection having created the receiver. Cannot be null

    Returns AmqpConnection

endHandler

  • endHandler(endHandler: ((res: void) => void) | Handler<void> | null | undefined): AmqpReceiver

  • Parameters

    • endHandler: ((res: void) => void) | Handler<void> | null | undefined

    Returns AmqpReceiver

exceptionHandler

  • exceptionHandler(handler: ((res: Throwable) => void) | Handler<Throwable> | null | undefined): AmqpReceiver

  • Parameters

    • handler: ((res: Throwable) => void) | Handler<Throwable> | null | undefined

    Returns AmqpReceiver

fetch

  • Parameters

    • amount: number

    Returns AmqpReceiver

handler

  • Parameters

    Returns AmqpReceiver

pause

  • Returns AmqpReceiver

pipe

  • Returns Pipe<AmqpMessage>

pipeTo

  • pipeTo(dst: WriteStream<AmqpMessage>): PromiseLike<void>
  • pipeTo(dst: WriteStream<AmqpMessage>, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

  • Parameters

    Returns PromiseLike<void>

  • Parameters

    • dst: WriteStream<AmqpMessage>
    • handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

    Returns void

resume

  • Returns AmqpReceiver

unwrap

  • unwrap(): any

  • Returns any

Generated using TypeDoc