Skip to content

Commit e00b9d2

Browse files
editorial review of addition of SqlServer message store methods (#6833)
* editorial review of addition of SqlServer message store methods * Update transports/msmq/delayed-delivery_content_msmqtransport_[2.0,).partial.md Co-authored-by: Adam Ralph <[email protected]> --------- Co-authored-by: Daniel Marbach <[email protected]>
1 parent ab50bd6 commit e00b9d2

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

transports/msmq/delayed-delivery_content_msmqtransport_[2.0,).partial.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -73,46 +73,46 @@ The built-in SQL Server delayed message store takes a pessimistic lock on the de
7373
> [!NOTE]
7474
> The following samples are adapted from the `SqlServerDelayedMessageStore` class provided with the MSMQ transport, and are provided as a guide for adapting to whatever persistence technology is required.
7575
76-
When creating a custom message store, the class can either implement `IDelayedMessageStore`
76+
When creating a custom message store, the class can either implement `IDelayedMessageStore`:
7777

7878
snippet: dms-without-infrastructure
7979

80-
or `IDelayedMessageStoreWithInfrastructure`
80+
or `IDelayedMessageStoreWithInfrastructure`:
8181

8282
snippet: dms-with-infrastructure
8383

84-
The only difference between the two interfaces is the `SetupInfrastructure` method, which must be implemented in `IDelayedMessageStoreWithInfrastructure` to create the required storage tables if they don't exist yet. With `IDelayedMessageStore` the storage tables are expected to already exist.
84+
The only difference between the two interfaces is the `SetupInfrastructure` method, which must be implemented for `IDelayedMessageStoreWithInfrastructure` to create the required storage tables if they don't yet exist. With `IDelayedMessageStore`, it is expected that the storage tables already exist:
8585

8686
snippet: dms-setup-infrastructure
8787

88-
In the above example, `TimeoutTableCreator` is responsible for executing the script against the database. For SQL Server, the script would be
88+
In the above example, `TimeoutTableCreator` is responsible for executing the script against the database. For SQL Server, the script is:
8989

9090
snippet: dms-sql-create-table
9191

92-
With both interfaces, the `Initialize` method will be called with the name of the endpoint being initialized. The storage implementation should throw an exception if it can't support specified transaction mode, e.g. TransactionScope mode requires the storage to enlist in a distributed transaction managed by the DTC.
92+
With both interfaces, the `Initialize` method is called with the name of the endpoint being initialized. The storage implementation should throw an exception if it doesn't support the specified transaction mode. For example, `TransactionScope` mode requires the storage to enlist in a distributed transaction managed by the DTC:
9393

9494
snippet: dms-initialise
9595

9696
snippet: dms-sql-crud
9797

98-
The remaining methods implement the logic required for the message store:
98+
The remaining methods implement the logic required for the message store.
9999

100-
`Store` Stores a delayed message.
100+
`Store` stores a delayed message:
101101

102102
snippet: dms-store
103103

104-
`Remove` Removes a due delayed message that has been dispatched to its destination from the store. It must return `true` if the removal succeeded or `false` if there was nothing to remove because the delayed message was already gone.
104+
`Remove` removes a delayed message that has been dispatched to its destination. It must return `true` if the removal succeeded or `false` if there was nothing to remove because the delayed message was already removed:
105105

106106
snippet: dms-remove
107107

108-
`IncrementFailureCount` Increments the counter of failures for a given due delayed message. It must return `true` if the increment succeeded or `false` if the delayed message was already gone.
108+
`IncrementFailureCount` increments the count of failures for a given delayed message. It must return `true` if the increment succeeded or `false` if the delayed message was already removed:
109109

110110
snippet: dms-increment-failure-count
111111

112-
`Next` Returns the date and time set for the next delayed message to become due or null if there are no delayed messages stored.
112+
`Next` returns the date and time when the next delayed message is due or `null` if there are no delayed messages:
113113

114114
snippet: dms-next
115115

116-
`FetchNextDueTimeout` Retrieves the oldest due delayed message from the store at a specified date and time, or returns null if there are no due delayed messages.
116+
`FetchNextDueTimeout` returns the next delayed message that will be due at a specified date and time or `null` if there will be no delayed messages at that date and time:
117117

118118
snippet: dms-fetch-next-duetimeout

0 commit comments

Comments
 (0)