Skip to content
This repository was archived by the owner on Apr 8, 2025. It is now read-only.

Commit c73fde9

Browse files
rahuldutta90vinjiang
authored andcommitted
Add documentation
1 parent 770097d commit c73fde9

File tree

1 file changed

+8
-2
lines changed
  • Microsoft.WindowsAzure.Storage/includes/was

1 file changed

+8
-2
lines changed

Microsoft.WindowsAzure.Storage/includes/was/core.h

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1203,6 +1203,7 @@ namespace azure { namespace storage {
12031203
/// <param name="last_request_result">The last request result.</param>
12041204
/// <param name="next_location">The next location to retry.</param>
12051205
/// <param name="current_location_mode">The current location mode.</param>
1206+
/// <param name="ex_ptr">Exception Ptr of any exception other than storage_exception</param>
12061207
retry_context(int current_retry_count, request_result last_request_result, storage_location next_location, location_mode current_location_mode, const std::exception_ptr& ex_ptr = nullptr)
12071208
: m_current_retry_count(current_retry_count), m_last_request_result(std::move(last_request_result)), m_next_location(next_location), m_current_location_mode(current_location_mode), m_unhandled_exception(ex_ptr)
12081209
{
@@ -1249,9 +1250,10 @@ namespace azure { namespace storage {
12491250
}
12501251

12511252
/// <summary>
1252-
/// Gets the results of the last request.
1253+
/// Gets the exception_ptr of any unhandled exception during the request.
1254+
/// Example: WinHttp exceptions for timeout (12002)
12531255
/// </summary>
1254-
/// <returns>An <see cref="azure::storage::request_result" /> object that represents the results of the last request.</returns>
1256+
/// <returns>An <see cref="std::exception_ptr" /> object that represents the results of the last request.</returns>
12551257
const request_result& last_request_result() const
12561258
{
12571259
return m_last_request_result;
@@ -1275,6 +1277,10 @@ namespace azure { namespace storage {
12751277
return m_current_location_mode;
12761278
}
12771279

1280+
/// <summary>
1281+
/// Gets the location mode for subsequent retries.
1282+
/// </summary>
1283+
/// <returns>The <see cref="azure::storage::location_mode" /> for subsequent retries.</returns>
12781284
const std::exception_ptr& unhandled_exception() const {
12791285
return m_unhandled_exception;
12801286
}

0 commit comments

Comments
 (0)