Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Queue

对message进行操作的队列对象 TODO: ChangeMessageVisibility PeekMessage BatchPeekMessage

Hierarchy

Index

Constructors

Events

Properties

Accessors

Methods

Object literals

Constructors

constructor

Events

startReceiving

  • startReceiving(numberOfMessages?: number, opt?: IReceiveOpt, condition?: function): Promise<void>

  • 开启循环轮训模式获取消息,消息会通过Queue.EVENTS.MESSAGE事件返回

    example

    queue.startReceiving();queue.on(Queue.EVENTS.MESSAGE,console.log);

    Parameters

    • Optional numberOfMessages: number
    • Optional opt: IReceiveOpt
    • Default value condition: function = () => true
        • (): boolean

        • Returns boolean

    Returns Promise<void>

Properties

Optional account

account: AliAccount

Private pollingLoopPull

pollingLoopPull: boolean = false

Private queueName

queueName: string

receiveMessage

receiveMessage: any = this.batchReceiveMessage.bind(this,1)

Optional region

region: string

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

Protected http

  • get http(): object

Methods

Private _addDeleteMethod

Private _startPollingLoopPull

  • _startPollingLoopPull(condition: function, oneshot: boolean, numberOfMessages?: any, opt?: IReceiveOpt): Promise<IQueueMessage[]>

  • Parameters

    • condition: function
        • (): boolean

        • Returns boolean

    • oneshot: boolean
    • Optional numberOfMessages: any
    • Optional opt: IReceiveOpt

    Returns Promise<IQueueMessage[]>

addListener

  • addListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

batchReceiveMessage

  • 批量获取消息

    throws

    MnsException

    Parameters

    • Default value numOfMessages: number = this.opt.numberOfMessages
    • Optional opt: IReceiveOpt

    Returns Promise<IQueueMessage[]>

batchSendMessage

deleteBatchByReceiptHandles

  • deleteBatchByReceiptHandles(receiptHandles: string[]): Promise<void>

  • 根据ReceiptHandles 批量删除消息

    Parameters

    • receiptHandles: string[]

    Returns Promise<void>

deleteByReceiptHandle

  • deleteByReceiptHandle(receiptHandle: string): Promise<void>

  • 根据ReceiptHandle 单独删除消息

    Parameters

    • receiptHandle: string

    Returns Promise<void>

deleteMsg

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

  • Returns Array<string | symbol>

Protected getHost

  • getHost(): string

getMaxListeners

  • getMaxListeners(): number

  • Returns number

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

on

  • on(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

once

  • once(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

pop

  • 该方法会持续轮训直到收到一个非空的消息，才会返回

    Parameters

    • Optional numberOfMessages: any
    • Optional opt: IReceiveOpt

    Returns Promise<IQueueMessage[]>

prependListener

  • prependListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

push

  • push(msg: any | string | string[] | any[], priority?: number, delaySeconds?: number): Promise<IResponse>

  • 队列发送消息,与send,batchSend相比在参数上更加友善

    throws

    MnsException

    Parameters

    • msg: any | string | string[] | any[]
    • Default value priority: number = this.opt.priority
    • Default value delaySeconds: number = this.opt.delaySeconds

    Returns Promise<IResponse>

rawListeners

  • rawListeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

Protected request

  • request(method: string, path: any, opt?: IRequestArg): Promise<object>

sendMessage

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

stopPollingLoopPull

  • stopPollingLoopPull(): void

  • 停止拉取消息循环 TODO: 立刻停止正在执行的长轮训

    Returns void

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number

  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Object literals

Private opt

opt: object

autoDelete

autoDelete: false = false

delaySeconds

delaySeconds: number = 0

numberOfMessages

numberOfMessages: number = 1

priority

priority: number = 8

waitseconds

waitseconds: number = 4

Static EVENTS

EVENTS: object

MESSAGE

MESSAGE: string = "message"

Generated using TypeDoc