你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
@azure/amqp-common package
Async |
|
Aad |
定义 AAD (Azure ActiveDirectory) TokenProvider。
这会接受包中的
|
Cbs |
|
Default |
Azure SDK 将使用的默认数据转换器。 |
Messaging |
描述消息传送错误的基类。 |
Request |
描述通过 amqp 会话创建的 amqp 请求 (发送方) 响应 (接收方) 链接。 |
Sas |
|
Timeout |
描述一个 Timeout 类,该类可以等待指定的时间量,然后使用给定值解析/拒绝承诺。 |
Async |
|
Connection |
描述在分析 EventHub 或 ServiceBus 连接字符串后创建的连接配置对象。 |
Connection |
|
Event |
描述在分析 EventHub 连接字符串后创建的连接配置对象。 它还提供了一些方便的方法,用于获取不同实体的地址和受众。 |
Message |
描述消息的已定义标准标头属性集。 |
Message |
描述消息的已定义标准属性集。 |
Amqp |
描述在网络上发送或接收的 AMQP 消息。 |
Amqp |
描述消息的已定义标准标头属性集。 |
Amqp |
描述消息的已定义标准属性集。 |
Async |
介绍可用于创建异步锁的选项。 |
Cbs |
介绍 CBS 响应。 |
Connection |
介绍创建连接配置时可以提供的选项。 |
Connection |
定义建立 AMQP 连接时需要设置的属性。 |
Create |
介绍可用于创建基本连接上下文的参数。 |
Data |
介绍在 (上发送数据或从线路) 接收数据之前,可以执行对数据进行编码/解码的转换。 |
Dictionary |
提供类似于结构 <键的字典,类型为 T 的值> 。 |
Event |
描述 eventhub 连接字符串模型。 |
Iot |
介绍 iothub 连接字符串模型。 |
Retry |
描述需要为重试操作配置的参数。 |
Send |
描述发送请求时可以指定的选项。 |
Service |
介绍 servicebus 连接字符串模型。 |
Storage |
介绍 stroage 连接字符串模型。 |
Token |
提供有关令牌的信息。 |
Token |
描述基本令牌提供程序。 |
Async |
|
Func |
函数类型的类型声明,其中 T 是函数的输入,V 是函数的输出。 |
Parsed |
使用 T 中定义的可能属性定义对象。 |
Condition |
将 amqp 错误条件映射到错误名称。 |
Condition |
将条件映射到数字 AMQP 响应状态代码。 |
Error |
将错误名称映射到 amqp 错误条件。 |
Retry |
描述重试操作类型。 RetryOperationType |
System |
将一些 SytemErrors 映射到 amqp 错误条件 SystemErrorConditionMapper |
Token |
描述支持的令牌的类型。 TokenType |
delay<T>(number, T) | setTimeout 的包装器,用于解析 t 毫秒后的承诺。 |
execute |
|
get |
获取具有所需设置的异步锁的新实例。 |
is |
确定给定的错误对象是否类似于 AmqpError 对象。 |
is |
确定给定的连接字符串是否为 iothub 连接字符串。 |
is |
|
parse |
分析连接字符串并返回 T 类型的对象。 连接字符串具有以下语法: ConnectionString ::= Part { “;”Part } [ “;” ][ WhiteSpace ]Part ::= [ PartLiteral [ “=” PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ::= ? 除 之外的任何字符序列;或 = 或 WhiteSpace? WhiteSpace ::= ? 所有空格字符,包括 \r 和 \n? |
random |
在给定间隔之间生成一个随机数 |
retry<T>(Retry |
它将尝试在每次重试之间以指定的延迟以线性方式重试指定的操作次数。 仅当错误可重试时,才会重试。 |
translate(Error | Amqp |
将协议层收到的 AQMP 错误或一般错误转换为 MessagingError。 |
setTimeout 的包装器,用于解析 t 毫秒后的承诺。
function delay<T>(t: number, value?: T): Promise<T>
参数
- t
-
number
要延迟的毫秒数。
- value
-
T
超时为 t 毫秒后要解析的值。
返回
Promise<T>
- 已解决的承诺
function executePromisesSequentially(promiseFactories: any[], kickstart?: any): Promise<any>
参数
- promiseFactories
-
any[]
- kickstart
-
any
返回
Promise<any>
获取具有所需设置的异步锁的新实例。
function getNewAsyncLock(options?: AsyncLockOptions): AsyncLock
参数
- options
- AsyncLockOptions
异步锁选项。
返回
AsyncLock
确定给定的错误对象是否类似于 AmqpError 对象。
function isAmqpError(err: any): boolean
参数
- err
-
any
AmqpError 对象
返回
boolean
result - true
如果它是 AMQP 错误,则为 ; false
否则为 。
确定给定的连接字符串是否为 iothub 连接字符串。
function isIotHubConnectionString(connectionString: string): boolean
参数
- connectionString
-
string
连接字符串。
返回
boolean
boolean。
function isSystemError(err: any): boolean
参数
- err
-
any
返回
boolean
分析连接字符串并返回 T 类型的对象。
连接字符串具有以下语法:
ConnectionString ::= Part { “;”Part } [ “;” ][ WhiteSpace ]Part ::= [ PartLiteral [ “=” PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ::= ? 除 之外的任何字符序列;或 = 或 WhiteSpace? WhiteSpace ::= ? 所有空格字符,包括 \r 和 \n?
function parseConnectionString<T>(connectionString: string): ParsedOutput<T>
参数
- connectionString
-
string
要分析的连接字符串。
返回
ParsedOutput<T>
ParsedOutput。
在给定间隔之间生成一个随机数
function randomNumberFromInterval(min: number, max: number): number
参数
- min
-
number
范围 (包含) 的最小数目。
- max
-
number
非独占) (范围的最大数目。
返回
number
它将尝试在每次重试之间以指定的延迟以线性方式重试指定的操作次数。 仅当错误可重试时,才会重试。
function retry<T>(config: RetryConfig<T>): Promise<T>
参数
- config
-
RetryConfig<T>
用于配置重试操作的参数。
返回
Promise<T>
承诺。
将协议层收到的 AQMP 错误或一般错误转换为 MessagingError。
function translate(err: Error | AmqpError): MessagingError
参数
- err
-
Error | AmqpError
收到的 amqp 错误。
返回
MessagingError 对象。