Skip to content

Commit 2533056

Browse files
mrjerryjohnsandy31415
authored andcommitted
Update ExchangeContext::SetResponseTimeout documentation (#22959)
Function description didn't provide details on what happens if you pass in 0. Co-authored-by: Andrei Litvin <[email protected]>
1 parent 5ded609 commit 2533056

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/messaging/ExchangeContext.h

+4
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,10 @@ class DLL_EXPORT ExchangeContext : public ReliableMessageContext,
183183
// Set the response timeout for the exchange context, regardless of the underlying session type. Using
184184
// UseSuggestedResponseTimeout to set a timeout based on the type of the session and the application processing time instead of
185185
// using this function is recommended.
186+
//
187+
// If a timeout of 0 is provided, it implies no response is expected. Consequently, ExchangeDelegate::OnResponseTimeout will not
188+
// be called.
189+
//
186190
void SetResponseTimeout(Timeout timeout);
187191

188192
// This API is used by commands that need to shut down all existing

0 commit comments

Comments
 (0)