Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[service-bus] Improve doc strings for create() methods on ServiceBusClient #8778

Merged
merged 11 commits into from
May 11, 2020
Merged

[service-bus] Improve doc strings for create() methods on ServiceBusClient #8778

Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
c815757
Improve doc comments for the various overloads.
richardpark-msft May 7, 2020
62c5363
Update documentation to reflect what the mode the user has chosen act…
richardpark-msft May 7, 2020
c4b0dc4
Meant to propagate the receiveMode to the deadLetterReceivers as well.
richardpark-msft May 7, 2020
6e5ad83
Updated with similar text to Ramya's suggestion
richardpark-msft May 7, 2020
909b9fc
Let's try this one out.
richardpark-msft May 7, 2020
3427842
We've got those entity specific names!
richardpark-msft May 7, 2020
7236754
Updated with Ramya's addition to mention the dead letter queue and im…
richardpark-msft May 7, 2020
e9fffc5
Improve the docs a bit more with feedback from Ramya.
richardpark-msft May 8, 2020
832f774
Add in the session enabled bit of documentation.
richardpark-msft May 9, 2020
37bab1c
Updated to include link to dead letter queues
richardpark-msft May 9, 2020
94fd960
Updated with links to how peekLock mode works in the service bus docu…
richardpark-msft May 11, 2020
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
145 changes: 121 additions & 24 deletions sdk/servicebus/service-bus/src/serviceBusClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,37 +79,67 @@ export class ServiceBusClient {
}

/**
* Creates a receiver for an Azure Service Bus queue.
* Creates a receiver for an Azure Service Bus queue in peekLock mode.
*
* In peekLock mode, the receiver has a lock on the message for the duration specified on the
* queue.
ramya-rao-a marked this conversation as resolved.
Show resolved Hide resolved
*
* Messages that are not settled within the lock duration will be redelivered as many times as
* the max delivery count set on the queue, after which they get sent to a separate dead letter
* queue.
*
* You can settle a message by calling complete(), abandon(), defer() or deadletter() methods on
* the message.
ramya-rao-a marked this conversation as resolved.
Show resolved Hide resolved
richardpark-msft marked this conversation as resolved.
Show resolved Hide resolved
*
* More information about how peekLock and message settlement works here:
* https://docs.microsoft.com/en-us/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
*
* @param queueName The name of the queue to receive from.
* @param receiveMode The receive mode to use (defaults to PeekLock)
* @param receiveMode The receive mode, defaulted to peekLock.
*/
createReceiver(queueName: string, receiveMode: "peekLock"): Receiver<ReceivedMessageWithLock>;
/**
* Creates a receiver for an Azure Service Bus queue.
* Creates a receiver for an Azure Service Bus queue in receiveAndDelete mode.
*
* In receiveAndDelete mode, messages are deleted from Service Bus as they are received.
*
* @param queueName The name of the queue to receive from.
* @param receiveMode The receive mode to use (defaults to PeekLock)
* @param receiveMode The receive mode, defaulted to receiveAndDelete.
*/
createReceiver(queueName: string, receiveMode: "receiveAndDelete"): Receiver<ReceivedMessage>;
/**
* Creates a receiver for an Azure Service Bus subscription.
* Creates a receiver for an Azure Service Bus subscription in peekLock mode.
*
* In peekLock mode, the receiver has a lock on the message for the duration specified on the
* subscription.
*
* Messages that are not settled within the lock duration will be redelivered as many times as
* the max delivery count set on the subscription, after which they get sent to a separate dead letter
* queue.
*
* You can settle a message by calling complete(), abandon(), defer() or deadletter() methods on
* the message.
*
* More information about how peekLock and message settlement works here:
* https://docs.microsoft.com/en-us/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
*
* @param topicName Name of the topic for the subscription we want to receive from.
* @param subscriptionName Name of the subscription (under the `topic`) that we want to receive from.
* @param receiveMode The receive mode to use (defaults to PeekLock)
* @param receiveMode The receive mode, defaulted to peekLock.
*/
createReceiver(
topicName: string,
subscriptionName: string,
receiveMode: "peekLock"
): Receiver<ReceivedMessageWithLock>;
/**
* Creates a receiver for an Azure Service Bus subscription.
* Creates a receiver for an Azure Service Bus subscription in receiveAndDelete mode.
*
* In receiveAndDelete mode, messages are deleted from Service Bus as they are received.
*
* @param topicName Name of the topic for the subscription we want to receive from.
* @param subscriptionName Name of the subscription (under the `topic`) that we want to receive from.
* @param receiveMode The receive mode to use (defaults to PeekLock)
* @param receiveMode The receive mode, defaulted to receiveAndDelete.
*/
createReceiver(
topicName: string,
Expand Down Expand Up @@ -152,10 +182,23 @@ export class ServiceBusClient {
}

/**
* Creates a receiver for an Azure Service Bus queue.
* Creates a receiver for a session enabled Azure Service Bus queue in peekLock mode.
*
* In peekLock mode, the receiver has a lock on the session for the duration specified on the
* queue.
*
* Messages that are not settled within the lock duration will be redelivered as many times as
* the max delivery count set on the queue, after which they get sent to a separate dead letter
* queue.
*
* You can settle a message by calling complete(), abandon(), defer() or deadletter() methods on
* the message.
*
* More information about how peekLock and message settlement works here:
* https://docs.microsoft.com/en-us/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
*
* @param queueName The name of the queue to receive from.
* @param receiveMode The receive mode to use (defaults to PeekLock)
* @param receiveMode The receive mode, defaulted to peekLock.
* @param options Options for the receiver itself.
*/
createSessionReceiver(
Expand All @@ -164,10 +207,12 @@ export class ServiceBusClient {
options?: CreateSessionReceiverOptions
): Promise<SessionReceiver<ReceivedMessageWithLock>>;
/**
* Creates a receiver for an Azure Service Bus queue.
* Creates a receiver for a session enabled Azure Service Bus queue in receiveAndDelete mode.
*
* In receiveAndDelete mode, messages are deleted from Service Bus as they are received.
*
* @param queueName The name of the queue to receive from.
* @param receiveMode The receive mode to use (defaults to PeekLock)
* @param receiveMode The receive mode, defaulted to receiveAndDelete.
* @param options Options for the receiver itself.
*/
createSessionReceiver(
Expand All @@ -176,11 +221,24 @@ export class ServiceBusClient {
options?: CreateSessionReceiverOptions
): Promise<SessionReceiver<ReceivedMessage>>;
/**
* Creates a receiver for an Azure Service Bus subscription.
* Creates a receiver for a session enabled Azure Service Bus subscription in peekLock mode.
*
* In peekLock mode, the receiver has a lock on the session for the duration specified on the
* subscription.
*
* Messages that are not settled within the lock duration will be redelivered as many times as
* the max delivery count set on the subscription, after which they get sent to a separate dead letter
* queue.
*
* You can settle a message by calling complete(), abandon(), defer() or deadletter() methods on
* the message.
*
* More information about how peekLock and message settlement works here:
* https://docs.microsoft.com/en-us/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
*
* @param topicName Name of the topic for the subscription we want to receive from.
* @param subscriptionName Name of the subscription (under the `topic`) that we want to receive from.
* @param receiveMode The receive mode to use (defaults to PeekLock)
* @param receiveMode The receive mode, defaulted to peekLock.
* @param options Options for the receiver itself.
*/
createSessionReceiver(
Expand All @@ -190,11 +248,13 @@ export class ServiceBusClient {
options?: CreateSessionReceiverOptions
): Promise<SessionReceiver<ReceivedMessageWithLock>>;
/**
* Creates a receiver for an Azure Service Bus subscription.
* Creates a receiver for a session enabled Azure Service Bus subscription in receiveAndDelete mode.
*
* In receiveAndDelete mode, messages are deleted from Service Bus as they are received.
*
* @param topicName Name of the topic for the subscription we want to receive from.
* @param subscriptionName Name of the subscription (under the `topic`) that we want to receive from.
* @param receiveMode The receive mode to use (defaults to PeekLock)
* @param receiveMode The receive mode, defaulted to receiveAndDelete.
* @param options Options for the receiver itself.
*/
createSessionReceiver(
Expand Down Expand Up @@ -271,43 +331,80 @@ export class ServiceBusClient {
// }

/**
* Creates a receiver for an Azure Service Bus queue's dead letter queue.
* Creates a receiver for an Azure Service Bus queue's dead letter queue in peekLock mode.
*
* In peekLock mode, the receiver has a lock on the message for the duration specified on the
* queue.
*
* In peekLock mode, the receiver has a lock on the message for the duration specified on the
* queue. Messages that are not settled within the lock duration will be redelivered.
*
* You can settle a message by calling complete(), abandon() or defer() methods on
* the message.
*
* See here for more information about dead letter queues:
* https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-dead-letter-queues
*
* More information about how peekLock and message settlement works here:
* https://docs.microsoft.com/en-us/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
*
* @param queueName The name of the queue to receive from.
* @param receiveMode The receive mode to use (defaults to PeekLock)
* @param receiveMode The receive mode, defaulted to peekLock.
*/
createDeadLetterReceiver(
queueName: string,
receiveMode: "peekLock"
): Receiver<ReceivedMessageWithLock>;
/**
* Creates a receiver for an Azure Service Bus queue's dead letter queue.
* Creates a receiver for an Azure Service Bus queue's dead letter queue in receiveAndDelete mode.
*
* In receiveAndDelete mode, messages are deleted from Service Bus as they are received.
*
* See here for more information about dead letter queues:
* https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-dead-letter-queues
*
* @param queueName The name of the queue to receive from.
* @param receiveMode The receive mode to use (defaults to PeekLock)
* @param receiveMode The receive mode, defaulted to receiveAndDelete.
*/
createDeadLetterReceiver(
queueName: string,
receiveMode: "receiveAndDelete"
): Receiver<ReceivedMessage>;
/**
* Creates a receiver for an Azure Service Bus subscription's dead letter queue.
* Creates a receiver for an Azure Service Bus subscription's dead letter queue in peekLock mode.
*
* In peekLock mode, the receiver has a lock on the message for the duration specified on the
* subscription. Messages that are not settled within the lock duration will be redelivered.
*
* You can settle a message by calling complete(), abandon() or defer() methods on
* the message.
*
* See here for more information about dead letter queues:
* https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-dead-letter-queues
*
* More information about how peekLock and message settlement works here:
* https://docs.microsoft.com/en-us/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
*
* @param topicName Name of the topic for the subscription we want to receive from.
* @param subscriptionName Name of the subscription (under the `topic`) that we want to receive from.
* @param receiveMode The receive mode to use (defaults to PeekLock)
* @param receiveMode The receive mode, defaulted to peekLock.
*/
createDeadLetterReceiver(
topicName: string,
subscriptionName: string,
receiveMode: "peekLock"
): Receiver<ReceivedMessageWithLock>;
/**
* Creates a receiver for an Azure Service Bus subscription's dead letter queue.
* Creates a receiver for an Azure Service Bus subscription's dead letter queue in receiveAndDelete mode.
*
* In receiveAndDelete mode, messages are deleted from Service Bus as they are received.
*
* See here for more information about dead letter queues:
* https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-dead-letter-queues
*
* @param topicName Name of the topic for the subscription we want to receive from.
* @param subscriptionName Name of the subscription (under the `topic`) that we want to receive from.
* @param receiveMode The receive mode to use (defaults to PeekLock)
* @param receiveMode The receive mode, defaulted to receiveAndDelete.
*/
createDeadLetterReceiver(
topicName: string,
Expand Down