@azure/core-amqp package
클래스
CbsClient |
AMQP 연결을 통해 $cbs 엔드포인트와 대화하는 EventHub/ServiceBus Cbs 클라이언트에 대해 설명합니다. |
MessagingError |
메시징 오류의 기본 클래스에 대해 설명합니다. |
RequestResponseLink |
amqp 세션을 통해 만들어진 amqp request(sender)-response(receiver) 링크를 설명합니다. |
인터페이스
AcquireLockProperties |
잠금을 획득하는 동안 제공해야 하는 속성에 대해 설명합니다. |
AmqpAnnotatedMessage |
ServiceBusReceivedMessage( |
AmqpMessageHeader |
메시지의 정의된 표준 헤더 속성 집합에 대해 설명합니다. |
AmqpMessageProperties |
메시지의 정의된 표준 속성 집합에 대해 설명합니다. |
CancellableAsyncLock |
CancelableAsyncLock은 동일한 '키'를 사용하여 작업을 직렬로 실행하도록 강제하는 메커니즘을 제공합니다. 보류 중인 작업은 abortSignal을 통해 수동으로 취소하거나 제공된 시간 제한 값에 도달하여 자동으로 취소할 수 있습니다. |
CbsResponse |
CBS 응답을 설명합니다. |
ConnectionConfig |
EventHub 또는 ServiceBus 연결 문자열을 구문 분석한 후 만들어진 연결 구성 개체에 대해 설명합니다. |
ConnectionConfigOptions |
연결 구성을 만드는 동안 제공할 수 있는 옵션에 대해 설명합니다. |
ConnectionContextBase |
기본 amqp 연결, cbs 세션, tokenProvider, 연결 구성, 데이터 변환기 등과 같은 컨텍스트 정보를 제공합니다. |
ConnectionProperties |
AMQP 연결을 설정하는 동안 설정해야 하는 속성을 정의합니다. |
CreateConnectionContextBaseParameters |
기본 연결 컨텍스트를 만들기 위해 제공할 수 있는 매개 변수에 대해 설명합니다. |
NetworkSystemError |
Node.js SystemError의 필드에 대해 설명합니다. 네트워크 호출과 관련이 없는 필드(예: 파일 시스템 호출)를 생략합니다. https://nodejs.org/dist/latest-v12.x/docs/api/errors.html#errors_class_systemerror를 참조하세요. |
RetryConfig |
재시도 작업에 대해 구성해야 하는 매개 변수에 대해 설명합니다. |
RetryOptions |
모드, 재시도 횟수, 재시도 간격 등을 결정하는 정책 옵션을 다시 시도합니다. |
SendRequestOptions |
요청을 보내는 동안 지정할 수 있는 옵션에 대해 설명합니다. |
WebSocketOptions |
웹 소켓을 통해 AMQP 연결의 채널링을 구성하는 옵션입니다. |
형식 별칭
ParsedOutput |
가능한 속성이 T에 정의된 개체를 정의합니다. |
열거형
ConditionErrorNameMapper |
amqp 오류 조건을 오류 이름에 매핑합니다. |
ErrorNameConditionMapper |
오류 이름을 amqp 오류 조건에 매핑합니다. |
RetryMode |
재시도 모드 유형에 대해 설명합니다. |
RetryOperationType |
재시도 작업 유형을 설명합니다. |
SystemErrorConditionMapper |
일부 SystemErrors를 amqp 오류 조건에 매핑 |
TokenType |
지원되는 토큰의 형식을 설명합니다. |
함수
delay<T>(number, Abort |
t 밀리초 후 약속을 확인하는 setTimeout에 대한 래퍼입니다. |
is |
오류가 MessagingError인지 확인합니다. |
is |
제공된 오류가 node.js SystemError인지 확인합니다. |
parse |
연결 문자열을 구문 분석하고 T 형식의 개체를 반환합니다. 연결 문자열에는 다음 구문이 있습니다. ConnectionString ::= |
retry<T>(Retry |
모든 작업은 한 번 이상 시도됩니다. 이전 시도가 다시 시도 가능한 오류와 함께 실패한 경우 추가 시도가 수행됩니다. 추가 시도 횟수는 인수에 옵션을 로 |
translate(unknown) | 프로토콜 계층 또는 SystemError에서 받은 AMQP 오류를 MessagingError로 변환합니다. 다른 모든 오류는 비정형으로 반환됩니다. |
함수 세부 정보
delay<T>(number, AbortSignalLike, string, T)
t 밀리초 후 약속을 확인하는 setTimeout에 대한 래퍼입니다.
function delay<T>(delayInMs: number, abortSignal?: AbortSignalLike, abortErrorMsg?: string, value?: T): Promise<T | void>
매개 변수
- delayInMs
-
number
지연될 시간(밀리초)입니다.
- abortSignal
-
AbortSignalLike
포함하는 작업과 연결된 abortSignal입니다.
- abortErrorMsg
-
string
포함 작업과 관련된 중단 오류 메시지입니다.
- value
-
T
시간 초과 후 확인할 값(밀리초)입니다.
반환
Promise<T | void>
- 해결된 약속
isMessagingError(Error | MessagingError)
오류가 MessagingError인지 확인합니다.
function isMessagingError(error: Error | MessagingError): error
매개 변수
- error
-
Error | MessagingError
오류 또는 MessagingError일 수 있는 오류입니다.
반환
error
isSystemError(unknown)
제공된 오류가 node.js SystemError인지 확인합니다.
function isSystemError(err: unknown): err
매개 변수
- err
-
unknown
오류 정보를 포함할 수 있는 개체입니다.
반환
err
parseConnectionString<T>(string)
연결 문자열을 구문 분석하고 T 형식의 개체를 반환합니다. 연결 문자열에는 다음 구문이 있습니다.
ConnectionString ::= Part { ";" Part } [ ";" ] [ WhiteSpace ]
Part ::= [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ::= ? 를 제외한 모든 문자 시퀀스 또는 = 또는 WhiteSpace ?
WhiteSpace ::= ? 및 을 \n
포함한 \r
모든 공백 문자
function parseConnectionString<T>(connectionString: string): ParsedOutput<T>
매개 변수
- connectionString
-
string
구문 분석할 연결 문자열입니다.
반환
ParsedOutput<T>
ParsedOutput.
retry<T>(RetryConfig<T>)
모든 작업은 한 번 이상 시도됩니다. 이전 시도가 다시 시도 가능한 오류와 함께 실패한 경우 추가 시도가 수행됩니다. 추가 시도 횟수는 인수에 maxRetries
제공된 속성에 RetryConfig
의해 제어됩니다.
옵션을 로 Fixed
설정하면 mode
지정된 작업에 대해 지정된 횟수에 대해 재시도를 수행하며, 매번 재시도할 때마다 지연이 고정됩니다.
옵션을 로 Exponential
설정하면 mode
전원 2의 백오프 요소를 사용할 때마다 재시도 사이의 지연이 기하급수적으로 증가하도록 조정됩니다.
function retry<T>(config: RetryConfig<T>): Promise<T>
매개 변수
- config
-
RetryConfig<T>
다시 시도 작업을 구성하는 매개 변수
반환
Promise<T>
약속.
translate(unknown)
프로토콜 계층 또는 SystemError에서 받은 AMQP 오류를 MessagingError로 변환합니다. 다른 모든 오류는 비정형으로 반환됩니다.
function translate(err: unknown): MessagingError | Error
매개 변수
- err
-
unknown
받은 amqp 오류입니다.
반환
MessagingError | Error
MessagingError 개체입니다.