@azure/amqp-common package
클래스
| AsyncLock | |
| AadTokenProvider |
AAD(Azure ActiveDirectory) TokenProvider를 정의합니다.
|
| CbsClient | |
| DefaultDataTransformer |
Azure SDK에서 사용할 기본 데이터 변환기입니다. |
| MessagingError |
메시징 오류의 기본 클래스에 대해 설명합니다. |
| RequestResponseLink |
amqp 세션을 통해 만들어진 amqp request(sender)-response(수신기) 링크를 설명합니다. |
| SasTokenProvider | |
| Timeout |
지정된 시간 동안 기다린 다음 지정된 값으로 프라미스를 확인/거부할 수 있는 Timeout 클래스에 대해 설명합니다. |
인터페이스
| AsyncLockOptions | |
| ConnectionConfig |
EventHub 또는 ServiceBus 연결 문자열을 구문 분석한 후 생성되는 연결 구성 개체에 대해 설명합니다. |
| ConnectionContextBase | |
| EventHubConnectionConfig |
EventHub 연결 문자열을 구문 분석한 후 생성되는 연결 구성 개체에 대해 설명합니다. 또한 다른 엔터티에 대한 주소 및 대상 그룹을 가져오기 위한 몇 가지 편리한 방법을 제공합니다. |
| MessageHeader |
메시지의 정의된 표준 헤더 속성 집합에 대해 설명합니다. |
| MessageProperties |
메시지의 정의된 표준 속성 집합에 대해 설명합니다. |
| AmqpMessage |
유선으로 보내거나 받는 AMQP 메시지를 설명합니다. |
| AmqpMessageHeader |
메시지의 정의된 표준 헤더 속성 집합에 대해 설명합니다. |
| AmqpMessageProperties |
메시지의 정의된 표준 속성 집합에 대해 설명합니다. |
| AsyncLockOptions |
비동기 잠금을 만들기 위해 제공할 수 있는 옵션에 대해 설명합니다. |
| CbsResponse |
CBS 응답을 설명합니다. |
| ConnectionConfigOptions |
연결 구성을 만드는 동안 제공할 수 있는 옵션에 대해 설명합니다. |
| ConnectionProperties |
AMQP 연결을 설정하는 동안 설정해야 하는 속성을 정의합니다. |
| CreateConnectionContextBaseParameters |
기본 연결 컨텍스트를 만들기 위해 제공할 수 있는 매개 변수에 대해 설명합니다. |
| DataTransformer |
유선으로 데이터를 보내거나 받기 전에 데이터를 인코딩/디코딩하기 위해 수행할 수 있는 변환에 대해 설명합니다. |
| Dictionary |
구조 <키, T 형식의 값> 같은 사전을 제공합니다. |
| EventHubConnectionStringModel |
eventhub 연결 문자열 모델에 대해 설명합니다. |
| IotHubConnectionStringModel |
iothub 연결 문자열 모델을 설명합니다. |
| RetryConfig |
다시 시도 작업에 대해 구성해야 하는 매개 변수에 대해 설명합니다. |
| SendRequestOptions |
요청을 보내는 동안 지정할 수 있는 옵션에 대해 설명합니다. |
| ServiceBusConnectionStringModel |
servicebus 연결 문자열 모델을 설명합니다. |
| StorageConnectionStringModel |
stroage 연결 문자열 모델을 설명합니다. |
| TokenInfo |
토큰에 대한 정보를 제공합니다. |
| TokenProvider |
기본 토큰 공급자를 설명합니다. |
형식 별칭
| AsyncLockDoneCallback | |
| Func |
함수 형식에 대한 형식 선언입니다. 여기서 T는 함수에 대한 입력이고 V는 함수의 출력입니다. |
| ParsedOutput |
가능한 속성이 T에 정의된 개체를 정의합니다. |
열거형
| ConditionErrorNameMapper |
amqp 오류 조건을 오류 이름에 매핑합니다. |
| ConditionStatusMapper |
조건을 숫자 AMQP 응답 상태 코드에 매핑합니다. |
| ErrorNameConditionMapper |
오류 이름을 amqp 오류 조건에 매핑합니다. |
| RetryOperationType |
재시도 작업 유형을 설명합니다. RetryOperationType |
| SystemErrorConditionMapper |
일부 SytemErrors를 amqp 오류 조건 SystemErrorConditionMapper에 매핑 |
| TokenType |
지원되는 토큰의 형식을 설명합니다. TokenType |
함수
| delay<T>(number, T) | 밀리초 후 약속을 확인하는 setTimeout에 대한 래퍼입니다. |
| execute |
|
| get |
원하는 설정을 사용하여 비동기 잠금의 새 인스턴스를 가져옵니다. |
| is |
지정된 오류 개체가 AmqpError 개체와 같은지 여부를 확인합니다. |
| is |
지정된 연결 문자열이 iothub 연결 문자열인지 여부를 확인합니다. |
| is |
|
| parse |
연결 문자열을 구문 분석하고 T 형식의 개체를 반환합니다. 연결 문자열에는 다음과 같은 구문이 사용됩니다. ConnectionString ::= Part { ";" Part } [ ";" ] [ 공백] Part ::= [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ::= ? 를 제외한 모든 문자 시퀀스 또는 = 또는 공백 ? 공백 ::= ? \r 및 \n 포함한 모든 공백 문자? |
| random |
지정된 간격 사이에 난수를 생성합니다. |
| retry<T>(Retry |
각 재시도 사이에 지정된 지연 시간을 사용하여 지정된 횟수만큼 작업을 선형으로 다시 시도합니다. 재시도는 오류를 다시 시도할 수 있는 경우에만 발생합니다. |
| translate(Error | Amqp |
프로토콜 계층에서 받은 AQMP 오류 또는 일반 오류를 MessagingError로 변환합니다. |
변수
| default |
|
| is |
이 상수는 환경이 node.js인지 브라우저 기반인지 나타내는 것입니다. |
| retryable |
재시도 가능한 AMQP 오류 목록을 제공합니다. "InternalServerError", "ServerBusyError", "ServiceUnavailableError", "OperationCancelledError", "SenderBusyError", "MessagingError", "DetachForcedError", "ConnectionForcedError", "TransferLimitExceededError", "OperationTimeoutError" |
함수 세부 정보
delay<T>(number, T)
밀리초 후 약속을 확인하는 setTimeout에 대한 래퍼입니다.
function delay<T>(t: number, value?: T): Promise<T>매개 변수
- t
-
number
지연될 시간(밀리초)입니다.
- value
-
T
시간 제한(밀리초) 후에 확인할 값입니다.
반환
Promise<T>
- 해결된 약속
executePromisesSequentially(any[], any)
function executePromisesSequentially(promiseFactories: any[], kickstart?: any): Promise<any>매개 변수
- promiseFactories
-
any[]
- kickstart
-
any
반환
Promise<any>
getNewAsyncLock(AsyncLockOptions)
원하는 설정을 사용하여 비동기 잠금의 새 인스턴스를 가져옵니다.
function getNewAsyncLock(options?: AsyncLockOptions): AsyncLock매개 변수
- options
- AsyncLockOptions
비동기 잠금 옵션입니다.
반환
AsyncLock
isAmqpError(any)
지정된 오류 개체가 AmqpError 개체와 같은지 여부를 확인합니다.
function isAmqpError(err: any): boolean매개 변수
- err
-
any
AmqpError 개체
반환
boolean
result - AMQP 오류인 경우 true. 그렇지 않으면 false.
isIotHubConnectionString(string)
지정된 연결 문자열이 iothub 연결 문자열인지 여부를 확인합니다.
function isIotHubConnectionString(connectionString: string): boolean매개 변수
- connectionString
-
string
연결 문자열입니다.
반환
boolean
부울.
isSystemError(any)
function isSystemError(err: any): boolean매개 변수
- err
-
any
반환
boolean
parseConnectionString<T>(string)
연결 문자열을 구문 분석하고 T 형식의 개체를 반환합니다.
연결 문자열에는 다음과 같은 구문이 사용됩니다.
ConnectionString ::= Part { ";" Part } [ ";" ] [ 공백] Part ::= [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ::= ? 를 제외한 모든 문자 시퀀스 또는 = 또는 공백 ? 공백 ::= ? \r 및 \n 포함한 모든 공백 문자?
function parseConnectionString<T>(connectionString: string): ParsedOutput<T>매개 변수
- connectionString
-
string
구문 분석할 연결 문자열입니다.
반환
ParsedOutput<T>
파싱아웃트<T>.
randomNumberFromInterval(number, number)
지정된 간격 사이에 난수를 생성합니다.
function randomNumberFromInterval(min: number, max: number): number매개 변수
- min
-
number
범위의 최소 번호(포함)입니다.
- max
-
number
범위의 최대 수(포함)입니다.
반환
number
retry<T>(RetryConfig<T>)
각 재시도 사이에 지정된 지연 시간을 사용하여 지정된 횟수만큼 작업을 선형으로 다시 시도합니다. 재시도는 오류를 다시 시도할 수 있는 경우에만 발생합니다.
function retry<T>(config: RetryConfig<T>): Promise<T>매개 변수
- config
-
RetryConfig<T>
재시도 작업을 구성하는 매개 변수입니다.
반환
Promise<T>
약속해<, T>.
translate(Error | AmqpError)
프로토콜 계층에서 받은 AQMP 오류 또는 일반 오류를 MessagingError로 변환합니다.
function translate(err: Error | AmqpError): MessagingError매개 변수
- err
-
Error | AmqpError
수신된 amqp 오류입니다.
반환
MessagingError 개체입니다.
Variable Details
defaultLock
isNode
이 상수는 환경이 node.js인지 브라우저 기반인지 나타내는 것입니다.
isNode: boolean형식
boolean
retryableErrors
재시도 가능한 AMQP 오류 목록을 제공합니다. "InternalServerError", "ServerBusyError", "ServiceUnavailableError", "OperationCancelledError", "SenderBusyError", "MessagingError", "DetachForcedError", "ConnectionForcedError", "TransferLimitExceededError", "OperationTimeoutError"
retryableErrors: string[]형식
string[]
