Skip to content

Commit

Permalink
Update ExchangeContext::SetResponseTimeout documentation (#22959)
Browse files Browse the repository at this point in the history
Function description didn't provide details on what happens if you pass
in 0.

Co-authored-by: Andrei Litvin <andy314@gmail.com>
  • Loading branch information
mrjerryjohns and andy31415 authored Sep 30, 2022
1 parent 3083b20 commit 2a1f9ef
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/messaging/ExchangeContext.h
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,10 @@ class DLL_EXPORT ExchangeContext : public ReliableMessageContext,
// Set the response timeout for the exchange context, regardless of the underlying session type. Using
// UseSuggestedResponseTimeout to set a timeout based on the type of the session and the application processing time instead of
// using this function is recommended.
//
// If a timeout of 0 is provided, it implies no response is expected. Consequently, ExchangeDelegate::OnResponseTimeout will not
// be called.
//
void SetResponseTimeout(Timeout timeout);

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

0 comments on commit 2a1f9ef

Please sign in to comment.