6.0.0 Documenation change, sample change and vcproj change

Author: katmsft

BreakingChanges.txt

@@ -1,5 +1,10 @@
 Azure Storage Client Library for C++
 History of Breaking Changes
+
+Breaking Changes in v6.0:
+- `azure::storage::blob_request_options` now accept max_execution_time as `std::chrono::milliseconds`. However, previous `std::chrono::seconds` can automatically converted to `std::chrono::milliseconds`. There can be behavioral change since the precision has changed.
+- Resolved an issue where the first forward slash in the front of the blob name will always be trimmed. This would cause blobs with name trimmed prior to this release no longer reachable with the same input.
+
 Breaking Changes in v5.0:
 - Dropped Nuget package with name 'wastorage'.
 

Changelog.txt

@@ -1,6 +1,14 @@
 Azure Storage Client Library for C++
 History of Changes
 
+Changes in v6.0.0
+- Upgraded CPPRest to latest version: 2.10.10.
+- Resolved a potential memory leak issue in xml_wrapper.cpp.
+- Resolved an issue where getting range would update the blob/file MD5 unexpectedly.
+- Added an option in CMake to build azure-storage-cpp using /MT 
+- Resolved an issue where the first forward slash in the front of the blob name will always be trimmed.
+- Supported cancellation token and millisecond level timeout in C++ client library.
+
 Changes in v5.2.0
 - Resolved an issue where listing blobs for blob tier returning faulty result when built with VS2013.
 - Resolved an issue where listing files or directories returning faulty server encryption status when built with VS2013.

Doxyfile

@@ -38,7 +38,7 @@ PROJECT_NAME           = "Microsoft Azure Storage Client Library for C++"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 5.2.0
+PROJECT_NUMBER         = 6.0.0
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

Microsoft.WindowsAzure.Storage/CMakeLists.txt

@@ -149,8 +149,8 @@ set(AZURESTORAGE_LIBRARY azurestorage)
 set(AZURESTORAGE_LIBRARIES ${AZURESTORAGE_LIBRARY} ${CASABLANCA_LIBRARY} ${Boost_LIBRARIES} ${Boost_FRAMEWORK} ${OPENSSL_LIBRARIES} ${UUID_LIBRARIES} ${LibXML2_LIBRARY} ${CMAKE_THREAD_LIBS_INIT})
 
 # Set version numbers centralized
-set (AZURESTORAGE_VERSION_MAJOR 5)
-set (AZURESTORAGE_VERSION_MINOR 2)
+set (AZURESTORAGE_VERSION_MAJOR 6)
+set (AZURESTORAGE_VERSION_MINOR 0)
 set (AZURESTORAGE_VERSION_REVISION 0)
 
 # Set output directories.

Microsoft.WindowsAzure.Storage/Microsoft.WindowsAzure.Storage.v140.vcxproj

@@ -98,7 +98,7 @@
       <SDLCheck>true</SDLCheck>
       <AdditionalOptions>/we4100 /Zm186 %(AdditionalOptions) /bigobj</AdditionalOptions>
       <TreatWarningAsError>true</TreatWarningAsError>
-      <AdditionalIncludeDirectories>includes</AdditionalIncludeDirectories>
+      <AdditionalIncludeDirectories>includes;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
       <MultiProcessorCompilation>true</MultiProcessorCompilation>
       <MinimalRebuild>false</MinimalRebuild>
     </ClCompile>
@@ -202,6 +202,7 @@
     <ClInclude Include="resource.h" />
   </ItemGroup>
   <ItemGroup>
+    <ClCompile Include="src\executor.cpp" />
     <ClCompile Include="src\timer_handler.cpp" />
     <ClCompile Include="src\authentication.cpp" />
     <ClCompile Include="src\basic_types.cpp" />

Microsoft.WindowsAzure.Storage/includes/wascore/constants.dat

@@ -338,21 +338,21 @@ DAT(xml_access_tier_inferred, _XPLATSTR("AccessTierInferred"))
 DAT(xml_access_tier_change_time, _XPLATSTR("AccessTierChangeTime"))
 
 #define STR(x) #x
-#define VER(x) _XPLATSTR("Azure-Storage/5.2.0 (Native; Windows; MSC_VER " STR(x) ")")
+#define VER(x) _XPLATSTR("Azure-Storage/6.0.0 (Native; Windows; MSC_VER " STR(x) ")")
 #if defined(_WIN32)
 #if defined(_MSC_VER)
     #if _MSC_VER >= 1900
         DAT(header_value_user_agent, VER(_MSC_VER))
     #elif _MSC_VER >= 1800
-        DAT(header_value_user_agent, _XPLATSTR("Azure-Storage/5.2.0 (Native; Windows; MSC_VER 18XX)"))
+        DAT(header_value_user_agent, _XPLATSTR("Azure-Storage/6.0.0 (Native; Windows; MSC_VER 18XX)"))
     #else
-        DAT(header_value_user_agent, _XPLATSTR("Azure-Storage/5.2.0 (Native; Windows; MSC_VER < 1800)"))
+        DAT(header_value_user_agent, _XPLATSTR("Azure-Storage/6.0.0 (Native; Windows; MSC_VER < 1800)"))
     #endif
 #else
-    DAT(header_value_user_agent, _XPLATSTR("Azure-Storage/5.2.0 (Native; Windows)"))
+    DAT(header_value_user_agent, _XPLATSTR("Azure-Storage/6.0.0 (Native; Windows)"))
 #endif
 #else
-    DAT(header_value_user_agent, _XPLATSTR("Azure-Storage/5.2.0 (Native)"))
+    DAT(header_value_user_agent, _XPLATSTR("Azure-Storage/6.0.0 (Native)"))
 #endif
 
 #endif // _CONSTANTS

Microsoft.WindowsAzure.Storage/samples/BlobsGettingStarted/Application.cpp

@@ -114,6 +114,34 @@ namespace azure { namespace storage { namespace samples {
             // Download append blob as text
             utility::string_t append_text = append_blob.download_text();
             ucout << _XPLATSTR("Append Text: ") << append_text << std::endl;
+
+            // Cancellation token
+            pplx::cancellation_token_source source; // This is used to cancel the request.
+            auto download_text_task = append_blob.download_text_async(azure::storage::access_condition(), azure::storage::blob_request_options(), azure::storage::operation_context(), source.get_token());
+            source.cancel();// This call will cancel download_text_task
+            try
+            {
+                auto downloaded_text = download_text_task.get();
+                ucout << _XPLATSTR("Text downloaded successfully unexpectedly, text is: ") << downloaded_text << std::endl;
+            }
+            catch (const azure::storage::storage_exception& e)
+            {
+                ucout << _XPLATSTR("Operation should be cancelled, the error message is: ") << e.what() << std::endl;
+            }
+
+            // Millisecond level timeout
+            azure::storage::blob_request_options options;
+            options.set_maximum_execution_time(std::chrono::milliseconds(1));
+            try
+            {
+                download_text_task = append_blob.download_text_async(azure::storage::access_condition(), options, azure::storage::operation_context());
+                auto downloaded_text = download_text_task.get();
+                ucout << _XPLATSTR("Text downloaded successfully unexpectedly, text is: ") << downloaded_text << std::endl;
+            }
+            catch (const azure::storage::storage_exception& e)
+            {
+                ucout << _XPLATSTR("Operation should be timed-out, the error message is: ") << e.what() << std::endl;
+            }
 
             // Delete the blob
             append_blob.delete_blob();

Microsoft.WindowsAzure.Storage/version.rc

@@ -1,4 +1,4 @@
-# Azure Storage Client Library for C++ (5.2.0)
+# Azure Storage Client Library for C++ (6.0.0)
 
 The Azure Storage Client Library for C++ allows you to build applications against Microsoft Azure Storage. For an overview of Azure Storage, see [Introduction to Microsoft Azure Storage](http://azure.microsoft.com/en-us/documentation/articles/storage-introduction/).
 
@@ -53,13 +53,31 @@ git clone https://github.com/Azure/azure-storage-cpp.git
 cd azure-storage-cpp
 ```
 
+To build with source code, there are three ways:
+
+**Via Vcpkg**
+You can manage the dependencies with Vcpkg, and use Visual Studio 2015 update 3 or Visual Studio 2017 for development environment. Simply install Casablanca via Vcpkg will setup everything needed.
+```
+C:\src\vcpkg> .\vcpkg install cpprestsdk
+```
+
+**Via NuGet**
+Because Casablanca does not release NuGet packages anywhere anymore, Starting from 5.1.0, this repository cannot be built with pre-built Casablanca NuGet packages. However, you can export your own version of Casablanca NuGet packages to install dependencies of this project:
+```
+C:\src\vcpkg> .\vcpkg install cpprestsdk
+C:\src\vcpkg> .\vcpkg export --nuget cpprestsdk --nuget-id=Casablanca --nuget-version=2.10.10
+```
+
+**Manage dependencies by yourself**
+It is not recommended to manage dependencies by yourself. However, you can still build Casablanca by yourself and specify the include directories and link binaries.
+
 ### Via NuGet
 
 To install the binaries for the Azure Storage Client Library for C++, you can export a NuGet package with Vcpkg and put it into your local NuGet feed. For more information about how to export a NuGet package, please see [Binary Export](https://github.com/Microsoft/vcpkg/blob/master/docs/specifications/export-command.md).
 
 Normally, exporting NuGet package is done with the following command:
 ```
-C:\src\vcpkg> .\vcpkg export --nuget azure-storage-cpp --nuget-id=Microsoft.Azure.Storage.CPP --nuget-version=5.1.0
+C:\src\vcpkg> .\vcpkg export --nuget azure-storage-cpp --nuget-id=Microsoft.Azure.Storage.CPP --nuget-version=6.0.0
 ```
 
 ### Via Vcpkg
@@ -94,6 +112,7 @@ The validated Casablanca version for each major or recent release on different p
 | 5.1.0                       | 2.10.6                         | 2.10.3                       |
 | 5.1.1                       | 2.10.6                         | 2.10.3                       |
 | 5.2.0                       | 2.10.6                         | 2.10.3                       |
+| 6.0.0                       | 2.10.10                        | 2.10.10                      |
 
 ## Code Samples
 
@@ -189,7 +208,7 @@ git clone https://github.com/Microsoft/cpprestsdk.git
 
 - Checkout the version on which Azure Storage Client Library for C++ depends:
 ```bash
-git checkout tags/v2.10.3 -b v2.10.3
+git checkout tags/v2.10.10 -b v2.10.10
 ```
 
 - Build the project in Release mode
@@ -298,7 +317,7 @@ git clone https://github.com/Microsoft/cpprestsdk.git
 
 - Checkout the version on which Azure Storage Client Library for C++ depends:
 ```bash
-git checkout tags/v2.10.3 -b v2.10.3
+git checkout tags/v2.10.10 -b v2.10.10
 ```
 
 - Build the project in Release mode
@@ -413,7 +432,7 @@ git clone https://github.com/Microsoft/cpprestsdk.git
 
 - Checkout the version on which Azure Storage Client Library for C++ depends:
 ```bash
-git checkout tags/v2.10.3 -b v2.10.3
+git checkout tags/v2.10.10 -b v2.10.10
 ```
 
 - Build the project in Release mode

README.md

@@ -10,7 +10,7 @@ rem Set the toolset
 set toolset=%4
 
 rem Get the casablanca version
-set casaver=2.10.6
+set casaver=2.10.10
 
 rem Build the packages.config file
 @echo