ServiceBusMessageActions class
通过 gRPC 在 Azure 服务总线 中提供定居和管理消息的操作。
该类包裹 gRPC 客户端调用,用于执行消息结算操作,如完成、放弃、死符、延迟,以及会话管理操作,如续期锁、设置会话状态和释放会话。
注解
- 需要一个实现 proto 文件中定义的结算服务的 gRPC 服务器。
- 所有方法都会抛出所有方法,如果缺少所需参数或 gRPC 调用失败。
方法
| abandon(Service |
放弃指定的消息,使其再次可供处理。 |
| complete(Service |
完成(结算)指定的消息,将其从队列或订阅中移除。 |
| deadletter(Service |
将指定的消息置于死符,并将其移至死符队列。 |
| defer(Service |
推迟指定消息,使其在通过序列号检索之前不可见。 |
| get |
|
| release |
释放指定的会话,使其可供其他接收器使用。 |
| renew |
对指定消息进行更新锁定,延长其锁定持续时间。 |
| renew |
对指定会话进行更新锁定,延长其锁定持续时间。 |
| set |
设置指定会话的状态。 |
方法详细信息
abandon(ServiceBusReceivedMessage, Record<string, any>)
放弃指定的消息,使其再次可供处理。
function abandon(message: ServiceBusReceivedMessage, propertiesToModify?: Record<string, any>): Promise<void>
参数
- message
- ServiceBusReceivedMessage
收到服务总线的弃置信息。
- propertiesToModify
-
Record<string, any>
可修改消息的可选属性。
返回
Promise<void>
一个在操作成功时解决的承诺。
complete(ServiceBusReceivedMessage)
完成(结算)指定的消息,将其从队列或订阅中移除。
function complete(message: ServiceBusReceivedMessage): Promise<void>
参数
- message
- ServiceBusReceivedMessage
收到的 服务总线 消息待完成。
返回
Promise<void>
一个在操作成功时解决的承诺。
deadletter(ServiceBusReceivedMessage, Record<string, any>, string, string)
将指定的消息置于死符,并将其移至死符队列。
function deadletter(message: ServiceBusReceivedMessage, propertiesToModify?: Record<string, any>, deadletterReason?: string, deadletterErrorDescription?: string): Promise<void>
参数
- message
- ServiceBusReceivedMessage
收到了 服务总线 的消息到死信。
- propertiesToModify
-
Record<string, any>
可修改消息的可选属性。
- deadletterReason
-
string
可选项使用死字母处理消息的原因。
- deadletterErrorDescription
-
string
可选的死写错误描述。
返回
Promise<void>
一个在操作成功时解决的承诺。
defer(ServiceBusReceivedMessage, Record<string, any>)
推迟指定消息,使其在通过序列号检索之前不可见。
function defer(message: ServiceBusReceivedMessage, propertiesToModify?: Record<string, any>): Promise<void>
参数
- message
- ServiceBusReceivedMessage
收到的 服务总线 消息以延迟。
- propertiesToModify
-
Record<string, any>
可修改消息的可选属性。
返回
Promise<void>
一个在操作成功时解决的承诺。
getInstance()
releaseSession(string)
释放指定的会话,使其可供其他接收器使用。
function releaseSession(sessionId: string): Promise<void>
参数
- sessionId
-
string
要释放的会话 ID。
返回
Promise<void>
一个在操作成功时解决的承诺。
renewMessageLock(ServiceBusReceivedMessage)
对指定消息进行更新锁定,延长其锁定持续时间。
function renewMessageLock(message: ServiceBusReceivedMessage): Promise<void>
参数
- message
- ServiceBusReceivedMessage
收到的 服务总线 消息,其锁应被续期。
返回
Promise<void>
一个在操作成功时解决的承诺。
renewSessionLock(string)
对指定会话进行更新锁定,延长其锁定持续时间。
function renewSessionLock(sessionId: string): Promise<Date>
参数
- sessionId
-
string
应更新锁的会话 ID。
返回
Promise<Date>
一个承诺,该承诺会以新的锁定截止日期为准。
setSessionState(string, Uint8Array)
设置指定会话的状态。
function setSessionState(sessionId: string, sessionState: Uint8Array): Promise<void>
参数
- sessionId
-
string
用于设置状态的会话 ID。
- sessionState
-
Uint8Array
会话要设置的状态。
返回
Promise<void>
一个在操作成功时解决的承诺。