ServiceBusSessionReceiver interface

세션 ID.

sessionId: string

속성 값

세션이 잠기기 전까지의 UTC 시간입니다. 호출될 때마다 renewSessionLock() 이 시간은 큐/구독을 만드는 동안 지정된 잠금 기간과 현재 시간으로 업데이트됩니다.

AMQP 수신기 링크가 세션에 대해 성공적으로 설정될 때까지 정의되지 않은 상태로 반환됩니다.

sessionLockedUntilUtc: Date

속성 값

수신기가 만들어진 엔터티의 경로입니다.

entityPath: string

속성 값

ServiceBusReceiver.entityPath에서 상속됨

수신기를 식별하는 데 사용되는 이름입니다. 로그와 예외의 상관 관계를 지정하는 데 사용할 수 있습니다. 지정하지 않았거나 비어 있으면 임의의 고유 항목이 생성됩니다.

identifier: string

속성 값

ServiceBusReceiver.identifier에서 상속됨

수신기 또는 수신기를 만든 클라이언트가 닫힌 경우 를 반환 true 합니다.

isClosed: boolean

속성 값

ServiceBusReceiver.isClosed에서 상속됨

수신기를 만드는 데 사용되는 수신 모드입니다.

receiveMode: "peekLock" | "receiveAndDelete"

속성 값

ServiceBusReceiver.receiveMode에서 상속됨

세션의 상태를 가져옵니다. 세션 상태에 대한 자세한 내용은 세션 상태를 참조하세요.

function getSessionState(options?: OperationOptionsBase): Promise<any>

매개 변수

반환

해당 세션의 상태

세션의 잠금을 갱신합니다.

function renewSessionLock(options?: OperationOptionsBase): Promise<Date>

매개 변수

반환

세션의 상태를 설정합니다. 세션 상태에 대한 자세한 내용은 세션 상태를 참조하세요.

function setSessionState(state: any, options?: OperationOptionsBase): Promise<void>

매개 변수

반환

메시지를 메시지 처리기로 스트리밍합니다.

function subscribe(handlers: MessageHandlers, options?: SubscribeOptions): { close() => Promise<void> }

매개 변수

반환

닫을 수 있는 개체로, 나머지 메시지를 handlers 보내고 새 메시지의 도착을 중지합니다.

수신자가 메시지에 보관한 잠금을 놓아 다른 수신 작업을 위해 Service Bus에서 메시지를 다시 사용할 수 있게 합니다.

function abandonMessage(message: ServiceBusReceivedMessage, propertiesToModify?: {[key: string]: number | boolean | string | Date | null}): Promise<void>

매개 변수

반환

ServiceBusReceiver.abandonMessage에서 상속됨

수신기를 닫습니다. 닫힌 후에는 수신기를 더 이상 작업에 사용할 수 없습니다. createReceiver() ServiceBusClient에서 메서드를 사용하여 새 수신기를 만듭니다.

function close(): Promise<void>

반환

ServiceBusReceiver.close에서 상속됨

Service Bus에서 메시지를 제거합니다.

function completeMessage(message: ServiceBusReceivedMessage): Promise<void>

매개 변수

반환

ServiceBusReceiver.completeMessage에서 상속됨

메시지를 배달 못 한 하위 큐로 이동합니다. 배달 못한 메시지를 받으려면 배달 못 한 하위 큐에 대한 경로를 사용하여 새 QueueClient/SubscriptionClient를 만듭니다.

function deadLetterMessage(message: ServiceBusReceivedMessage, options?: DeadLetterOptions & {[key: string]: number | boolean | string | Date | null}): Promise<void>

매개 변수

반환

ServiceBusReceiver.deadLetterMessage에서 상속됨

메시지 처리를 연기합니다. sequenceNumber 나중에 메서드를 사용하여 메시지를 다시 받으려면 메시지의 를 저장합니다receiveDeferredMessage.

function deferMessage(message: ServiceBusReceivedMessage, propertiesToModify?: {[key: string]: number | boolean | string | Date | null}): Promise<void>

매개 변수

반환

ServiceBusReceiver.deferMessage에서 상속됨

Service Bus에서 메시지를 받는 데 사용할 수 있는 반복기를 반환합니다.

function getMessageIterator(options?: GetMessageIteratorOptions): AsyncIterableIterator<ServiceBusReceivedMessage>

매개 변수

반환

ServiceBusReceiver.getMessageIterator에서 상속됨

큐 또는 구독에서 활성 메시지(지연되었지만 배달되지 않은 메시지 포함)의 다음 일괄 처리를 수정하지 않고 피킹합니다.

• 에 대한 peekMessages() 첫 번째 호출은 첫 번째 활성 메시지를 가져옵니다. 각 후속 호출은 후속 메시지를 가져옵니다.
• "받은" 메시지와 달리 "피킹된" 메시지는 메시지의 읽기 전용 버전입니다. Completed/Abandoned/Deferred/Deadlettered일 수 없습니다.

function peekMessages(maxMessageCount: number, options?: PeekMessagesOptions): Promise<ServiceBusReceivedMessage[]>

매개 변수

반환

ServiceBusReceiver.peekMessages에서 상속됨

지정된 sequenceNumbers로 식별된 지연된 메시지 배열로 확인되는 프라미스를 반환합니다.

function receiveDeferredMessages(sequenceNumbers: Long | Long[], options?: OperationOptionsBase): Promise<ServiceBusReceivedMessage[]>

매개 변수

반환

지정된 시퀀스Numbers로 식별된 메시지 목록 또는 메시지가 없는 경우 빈 목록입니다.

ServiceBusReceiver.receiveDeferredMessages에서 상속됨

Service Bus에서 받은 메시지 배열로 확인되는 프라미스를 반환합니다.

function receiveMessages(maxMessageCount: number, options?: ReceiveMessagesOptions): Promise<ServiceBusReceivedMessage[]>

매개 변수

반환

메시지 배열로 해결되는 약속입니다.

ServiceBusReceiver.receiveMessages에서 상속됨

큐/구독을 만드는 동안 지정된 기간 동안 메시지의 잠금을 갱신합니다.

• 잠금이 lockedUntilUtc 만료되는 시간에 대한 메시지의 속성을 확인합니다.
• 메시지가 고정되지 않은 경우(잠금이 만료되기 전에 , defer() 또는 deadletter()을 사용하여complete()) 메시지가 다음 수신 작업을 위해 큐/구독에 다시 배치됩니다.

function renewMessageLock(message: ServiceBusReceivedMessage): Promise<Date>

매개 변수

반환

UTC 형식의 새 잠금 토큰 만료 날짜 및 시간입니다.

ServiceBusReceiver.renewMessageLock에서 상속됨