Lezen in het Engels

Delen via


@azure/amqp-common package

Klassen

AsyncLock
AadTokenProvider

Definieert de AAD-tokenprovider (Azure ActiveDirectory). Hiermee worden de volgende referenties uit het @azure/ms-rest-nodeauth pakket geaccepteerd:

  • ApplicationTokenCredentials
  • UserTokenCredentials
  • DeviceTokenCredentials
  • MSITokenCredentials (MSIVmTokenCredentials)
CbsClient
DefaultDataTransformer

De standaardgegevenstransformatie die wordt gebruikt door de Azure SDK.

MessagingError

Beschrijft de basisklasse voor Berichtfout.

RequestResponseLink

Beschrijft een koppeling amqp request(sender)-response(receiver) die is gemaakt via een amqp-sessie.

SasTokenProvider
Timeout

Beschrijft een time-outklasse die de opgegeven tijd kan wachten en vervolgens de belofte met de opgegeven waarde kan oplossen/afwijzen.

Interfaces

AsyncLockOptions
ConnectionConfig

Beschrijft het configuratieobject voor de verbinding dat wordt gemaakt na het parseren van een EventHub- of ServiceBus-connection string.

ConnectionContextBase
EventHubConnectionConfig

Beschrijft het configuratieobject voor de verbinding dat wordt gemaakt na het parseren van een EventHub-connection string. Het biedt ook enkele handige methoden voor het ophalen van het adres en de doelgroep voor verschillende entiteiten.

MessageHeader

Beschrijft de gedefinieerde set standaardheadereigenschappen van het bericht.

MessageProperties

Beschrijft de gedefinieerde set standaardeigenschappen van het bericht.

AmqpMessage

Hierin wordt het AMQP-bericht beschreven dat op de draad wordt verzonden of ontvangen.

AmqpMessageHeader

Beschrijft de gedefinieerde set standaardheadereigenschappen van het bericht.

AmqpMessageProperties

Beschrijft de gedefinieerde set standaardeigenschappen van het bericht.

AsyncLockOptions

Hierin worden de opties beschreven die kunnen worden geboden om een asynchrone vergrendeling te maken.

CbsResponse

Hierin wordt het CBS-antwoord beschreven.

ConnectionConfigOptions

Hierin worden de opties beschreven die kunnen worden opgegeven tijdens het maken van een verbindingsconfiguratie.

ConnectionProperties

Hiermee definieert u de eigenschappen die moeten worden ingesteld tijdens het tot stand brengen van de AMQP-verbinding.

CreateConnectionContextBaseParameters

Beschrijft de parameters die kunnen worden opgegeven om de context van de basisverbinding te maken.

DataTransformer

Hierin worden de transformaties beschreven die kunnen worden uitgevoerd om de gegevens te coderen/decoderen voordat ze worden verzonden op (of ontvangen van) de kabel.

Dictionary

Biedt een woordenlijst zoals structuursleutel <, waarde> van type T.

EventHubConnectionStringModel

Hierin wordt het eventhub-connection string-model beschreven.

IotHubConnectionStringModel

Hierin wordt het iothub connection string-model beschreven.

RetryConfig

Beschrijft de parameters die moeten worden geconfigureerd voor de bewerking voor opnieuw proberen.

SendRequestOptions

Beschrijft de opties die kunnen worden opgegeven tijdens het verzenden van een aanvraag.

ServiceBusConnectionStringModel

Beschrijft het servicebus-connection string-model.

StorageConnectionStringModel

Hierin wordt het model connection string beschreven.

TokenInfo

Bevat informatie over het token.

TokenProvider

Beschrijft de basistokenprovider.

Type-aliassen

AsyncLockDoneCallback
Func

Typedeclaratie voor een functietype waarbij T de invoer voor de functie is en V de uitvoer van de functie is.

ParsedOutput

Hiermee definieert u een object met mogelijke eigenschappen die zijn gedefinieerd in T.

Enums

ConditionErrorNameMapper

Wijst de amqp-foutvoorwaarden toe aan de foutnamen.

ConditionStatusMapper

Wijst de voorwaarden toe aan de numerieke AMQP-antwoordstatuscodes.

ErrorNameConditionMapper

Wijst de foutnamen toe aan de amqp-foutvoorwaarden.

RetryOperationType

Beschrijft het type bewerking voor opnieuw proberen. RetryOperationType

SystemErrorConditionMapper

Wijst enkele SytemErrors toe aan amqp-foutvoorwaarden SystemErrorConditionMapper

TokenType

Beschrijft het type ondersteunde tokens. TokenType

Functies

delay<T>(number, T)

Een wrapper voor setTimeout waarmee een belofte na t milliseconden wordt omgezet.

executePromisesSequentially(any[], any)
getNewAsyncLock(AsyncLockOptions)

Hiermee haalt u een nieuw exemplaar van de asynchrone vergrendeling op met de gewenste instellingen.

isAmqpError(any)

Bepaalt of het gegeven foutobject op een AmqpError-object lijkt.

isIotHubConnectionString(string)

Bepaalt of de opgegeven connection string een iothub-connection string is.

isSystemError(any)
parseConnectionString<T>(string)

Parseert de connection string en retourneert een object van het type T.

Verbindingsreeksen hebben de volgende syntaxis:

ConnectionString ::= Part { ";" Deel } [ ";" ] [ Witruimte ] Part ::= [ PartLiteral [ "=" PartLiteral ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ::= ? elke reeks tekens, met uitzondering van ; of = of witruimte? Witruimte ::= ? alle witruimtetekens, inclusief \r en \n?

randomNumberFromInterval(number, number)

Genereert een willekeurig getal tussen het opgegeven interval

retry<T>(RetryConfig<T>)

Er wordt geprobeerd om een bewerking die is opgegeven aantal keren lineair opnieuw uit te voeren met een opgegeven vertraging tussen elke nieuwe poging. De nieuwe pogingen vinden alleen plaats als de fout opnieuw kan worden geprobeerd.

translate(Error | AmqpError)

Vertaalt de AQMP-fout die is ontvangen op de protocollaag of een algemene fout in een MessagingError.

Functiedetails

delay<T>(number, T)

Een wrapper voor setTimeout waarmee een belofte na t milliseconden wordt omgezet.

function delay<T>(t: number, value?: T): Promise<T>

Parameters

t

number

Het aantal milliseconden dat moet worden vertraagd.

value

T

De waarde waarmee moet worden omgezet na een time-out van t milliseconden.

Retouren

Promise<T>

  • Opgeloste belofte

executePromisesSequentially(any[], any)

function executePromisesSequentially(promiseFactories: any[], kickstart?: any): Promise<any>

Parameters

promiseFactories

any[]

kickstart

any

Retouren

Promise<any>

getNewAsyncLock(AsyncLockOptions)

Hiermee haalt u een nieuw exemplaar van de asynchrone vergrendeling op met de gewenste instellingen.

function getNewAsyncLock(options?: AsyncLockOptions): AsyncLock

Parameters

options
AsyncLockOptions

De opties voor asynchrone vergrendeling.

Retouren

Asynchroonlock

isAmqpError(any)

Bepaalt of het gegeven foutobject op een AmqpError-object lijkt.

function isAmqpError(err: any): boolean

Parameters

err

any

Het Object AmqpError

Retouren

boolean

result: true als het een AMQP-fout is; false anders.

isIotHubConnectionString(string)

Bepaalt of de opgegeven connection string een iothub-connection string is.

function isIotHubConnectionString(connectionString: string): boolean

Parameters

connectionString

string

De connection string.

Retouren

boolean

Booleaanse.

isSystemError(any)

function isSystemError(err: any): boolean

Parameters

err

any

Retouren

boolean

parseConnectionString<T>(string)

Parseert de connection string en retourneert een object van het type T.

Verbindingsreeksen hebben de volgende syntaxis:

ConnectionString ::= Part { ";" Deel } [ ";" ] [ Witruimte ] Part ::= [ PartLiteral [ "=" PartLiteral ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ::= ? elke reeks tekens, met uitzondering van ; of = of witruimte? Witruimte ::= ? alle witruimtetekens, inclusief \r en \n?

function parseConnectionString<T>(connectionString: string): ParsedOutput<T>

Parameters

connectionString

string

De connection string die moeten worden geparseerd.

Retouren

ParsedOutput.

randomNumberFromInterval(number, number)

Genereert een willekeurig getal tussen het opgegeven interval

function randomNumberFromInterval(min: number, max: number): number

Parameters

min

number

Minimumaantal van het bereik (inclusief).

max

number

Maximumaantal van het bereik (inclusief).

Retouren

number

retry<T>(RetryConfig<T>)

Er wordt geprobeerd om een bewerking die is opgegeven aantal keren lineair opnieuw uit te voeren met een opgegeven vertraging tussen elke nieuwe poging. De nieuwe pogingen vinden alleen plaats als de fout opnieuw kan worden geprobeerd.

function retry<T>(config: RetryConfig<T>): Promise<T>

Parameters

config

RetryConfig<T>

Parameters voor het configureren van de bewerking voor opnieuw proberen.

Retouren

Promise<T>

Belofte.

translate(Error | AmqpError)

Vertaalt de AQMP-fout die is ontvangen op de protocollaag of een algemene fout in een MessagingError.

function translate(err: Error | AmqpError): MessagingError

Parameters

err

Error | AmqpError

De amqp-fout die is ontvangen.

Retouren

MessagingError-object.