Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ReceiveHandler

Package version

Describes the receive handler object that is returned from the receive() method with handlers. The ReceiveHandler is used to stop receiving more messages.

class

ReceiveHandler

Hierarchy

  • ReceiveHandler

Index

Constructors

Accessors

Methods

Constructors

constructor

  • Creates an instance of the ReceiveHandler.

    constructor
    internal

    Parameters

    • receiver: EventHubReceiver

      The underlying EventHubReceiver.

    Returns ReceiveHandler

Accessors

consumerGroup

  • get consumerGroup(): string | undefined
  • property

    The consumer group from which the handler is receiving events.

    readonly

    Returns string | undefined

isReceiverOpen

  • get isReceiverOpen(): boolean
  • property

    Indicates whether the receiver is connected/open. true - is open; false otherwise.

    readonly

    Returns boolean

partitionId

  • get partitionId(): string | undefined
  • property

    The partitionId from which the handler is receiving events.

    readonly

    Returns string | undefined

Methods

stop

  • stop(): Promise<void>

  • Stops the underlying EventHubReceiver from receiving more messages.

    throws

    {Error} Thrown if the underlying connection encounters an error while closing.

    Returns Promise<void>

    Promise

Generated using TypeDoc