Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 4 additions & 16 deletions sdk/servicebus/service-bus/review/service-bus.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,16 +189,6 @@ export type EntityStatus = "Active" | "Creating" | "Deleting" | "ReceiveDisabled
export interface GetMessageIteratorOptions extends OperationOptionsBase {
}

// @public
export interface MessageHandlerOptions extends MessageHandlerOptionsBase {
}

// @public
export interface MessageHandlerOptionsBase extends OperationOptionsBase {
autoComplete?: boolean;
maxConcurrentCalls?: number;
}

// @public
export interface MessageHandlers<ReceivedMessageT> {
processError(err: Error): Promise<void>;
Expand Down Expand Up @@ -463,15 +453,11 @@ export interface ServiceBusSessionReceiver<ReceivedMessageT extends ServiceBusRe
readonly sessionId: string;
readonly sessionLockedUntilUtc: Date;
setSessionState(state: any, options?: OperationOptionsBase): Promise<void>;
subscribe(handlers: MessageHandlers<ReceivedMessageT>, options?: SessionSubscribeOptions): {
subscribe(handlers: MessageHandlers<ReceivedMessageT>, options?: SubscribeOptions): {
close(): Promise<void>;
};
}

// @public
export interface SessionSubscribeOptions extends MessageHandlerOptionsBase {
}

// @public
export type SqlRuleAction = {
sqlExpression?: string;
Expand All @@ -492,7 +478,9 @@ export interface SqlRuleFilter {
export type SubQueue = "deadLetter" | "transferDeadLetter";

// @public
export interface SubscribeOptions extends MessageHandlerOptions {
export interface SubscribeOptions extends OperationOptionsBase {
autoComplete?: boolean;
maxConcurrentCalls?: number;
}

// @public
Expand Down
4 changes: 2 additions & 2 deletions sdk/servicebus/service-bus/src/core/messageReceiver.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import { LinkEntity, ReceiverType } from "./linkEntity";
import { ConnectionContext } from "../connectionContext";
import { DispositionType, InternalReceiveMode, ServiceBusMessageImpl } from "../serviceBusMessage";
import { getUniqueName } from "../util/utils";
import { MessageHandlerOptions } from "../models";
import { SubscribeOptions } from "../models";
import { DispositionStatusOptions } from "./managementClient";
import { AbortSignalLike } from "@azure/core-http";
import { onMessageSettled, DeferredPromiseAndTimer } from "./shared";
Expand Down Expand Up @@ -42,7 +42,7 @@ export interface OnAmqpEventAsPromise extends OnAmqpEvent {
* @internal
* @ignore
*/
export interface ReceiveOptions extends MessageHandlerOptions {
export interface ReceiveOptions extends SubscribeOptions {
/**
* @property {number} [receiveMode] The mode in which messages should be received.
*/
Expand Down
3 changes: 0 additions & 3 deletions sdk/servicebus/service-bus/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,10 @@ export {
CreateReceiverOptions,
AcceptSessionOptions,
GetMessageIteratorOptions,
MessageHandlerOptions,
MessageHandlerOptionsBase,
MessageHandlers,
PeekMessagesOptions,
ReceiveMessagesOptions,
ReceiveMode,
SessionSubscribeOptions,
SubQueue,
SubscribeOptions
} from "./models";
Expand Down
19 changes: 1 addition & 18 deletions sdk/servicebus/service-bus/src/models.ts
Original file line number Diff line number Diff line change
Expand Up @@ -130,18 +130,7 @@ export interface GetMessageIteratorOptions extends OperationOptionsBase {}
/**
* Options used when subscribing to a Service Bus queue or subscription.
*/
export interface SubscribeOptions extends MessageHandlerOptions {}

/**
* Options used when subscribing to a Service Bus queue or subscription.
*/
export interface SessionSubscribeOptions extends MessageHandlerOptionsBase {}

/**
* Describes the options passed to `registerMessageHandler` method when receiving messages from a
* Queue/Subscription.
*/
export interface MessageHandlerOptionsBase extends OperationOptionsBase {
export interface SubscribeOptions extends OperationOptionsBase {
/**
* @property Indicates whether the `complete()` method on the message should automatically be
* called by the sdk after the user provided onMessage handler has been executed.
Expand All @@ -158,12 +147,6 @@ export interface MessageHandlerOptionsBase extends OperationOptionsBase {
maxConcurrentCalls?: number;
}

/**
* Describes the options passed to `registerMessageHandler` method when receiving messages from a
* Queue/Subscription which does not have sessions enabled.
*/
export interface MessageHandlerOptions extends MessageHandlerOptionsBase {}

/**
* Describes the options passed to the `acceptSession` and `acceptNextSession` methods
* when using a Queue/Subscription that has sessions enabled.
Expand Down
13 changes: 4 additions & 9 deletions sdk/servicebus/service-bus/src/receivers/sessionReceiver.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,7 @@

import { ConnectionContext } from "../connectionContext";
import { MessageHandlers, ReceiveMessagesOptions, ServiceBusReceivedMessage } from "..";
import {
PeekMessagesOptions,
GetMessageIteratorOptions,
MessageHandlerOptionsBase,
SessionSubscribeOptions
} from "../models";
import { PeekMessagesOptions, GetMessageIteratorOptions, SubscribeOptions } from "../models";
import { MessageSession } from "../session/messageSession";
import {
getAlreadyReceivingErrorMsg,
Expand Down Expand Up @@ -68,7 +63,7 @@ export interface ServiceBusSessionReceiver<
*/
subscribe(
handlers: MessageHandlers<ReceivedMessageT>,
options?: SessionSubscribeOptions
options?: SubscribeOptions
): {
/**
* Causes the subscriber to stop receiving new messages.
Expand Down Expand Up @@ -406,7 +401,7 @@ export class ServiceBusSessionReceiverImpl<

subscribe(
handlers: MessageHandlers<ReceivedMessageT>,
options?: SessionSubscribeOptions
options?: SubscribeOptions
): {
close(): Promise<void>;
} {
Expand Down Expand Up @@ -455,7 +450,7 @@ export class ServiceBusSessionReceiverImpl<
private _registerMessageHandler(
onMessage: OnMessage,
onError: OnError,
options?: MessageHandlerOptionsBase
options?: SubscribeOptions
): void {
this._throwIfReceiverOrConnectionClosed();
this._throwIfAlreadyReceiving();
Expand Down
4 changes: 2 additions & 2 deletions sdk/servicebus/service-bus/src/session/messageSession.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import { BatchingReceiverLite, MinimalReceiver } from "../core/batchingReceiver"
import { onMessageSettled, DeferredPromiseAndTimer } from "../core/shared";
import { AbortError, AbortSignalLike } from "@azure/abort-controller";
import { ReceiverHelper } from "../core/receiverHelper";
import { AcceptSessionOptions, MessageHandlerOptionsBase } from "../models";
import { AcceptSessionOptions, SubscribeOptions } from "../models";

/**
* Describes the options that need to be provided while creating a message session receiver link.
Expand Down Expand Up @@ -624,7 +624,7 @@ export class MessageSession extends LinkEntity<Receiver> {
*
* @returns void
*/
subscribe(onMessage: OnMessage, onError: OnError, options?: MessageHandlerOptionsBase): void {
subscribe(onMessage: OnMessage, onError: OnError, options?: SubscribeOptions): void {
if (!options) options = {};

if (options.abortSignal?.aborted) {
Expand Down