Updating to latest API naming convention (microsoft#356)

Author: jasonsandlin

Include/httpClient/httpClient.h

@@ -20,10 +20,10 @@
 /// </remarks>
 typedef void
 (CALLBACK* HCCallPerformFunction)(
-    _In_ hc_call_handle_t call,
+    _In_ HCCallHandle call,
     _Inout_ XAsyncBlock* asyncBlock,
     _In_opt_ void* context,
-    _In_ hc_perform_env env
+    _In_ HCPerformEnv env
     );
 
 /// <summary>
@@ -70,7 +70,7 @@ STDAPI HCGetHttpCallPerformFunction(
 /// <param name="context">the context pointer attached to this call object</param>
 /// <returns>Result code for this API operation.  Possible values are S_OK, E_INVALIDARG, or E_FAIL.</returns>
 STDAPI HCHttpCallGetContext(
-    _In_ hc_call_handle_t call,
+    _In_ HCCallHandle call,
     _In_ void** context
     ) HC_NOEXCEPT;
 
@@ -81,7 +81,7 @@ STDAPI HCHttpCallGetContext(
 /// <param name="context">the context pointer attached to this call object</param>
 /// <returns>Result code for this API operation.  Possible values are S_OK, E_INVALIDARG, or E_FAIL.</returns>
 STDAPI HCHttpCallSetContext(
-    _In_ hc_call_handle_t call,
+    _In_ HCCallHandle call,
     _In_ void* context
     ) HC_NOEXCEPT;
 
@@ -98,7 +98,7 @@ STDAPI HCHttpCallSetContext(
 /// <param name="url">UTF-8 encoded URL for the HTTP call</param>
 /// <returns>Result code for this API operation.  Possible values are S_OK, E_INVALIDARG, or E_FAIL.</returns>
 STDAPI HCHttpCallRequestGetUrl(
-    _In_ hc_call_handle_t call,
+    _In_ HCCallHandle call,
     _Outptr_ const char** method,
     _Outptr_ const char** url
     ) HC_NOEXCEPT;
@@ -111,7 +111,7 @@ STDAPI HCHttpCallRequestGetUrl(
 /// <param name="requestBodySize">The request body bytes size in bytes of the HTTP call</param>
 /// <returns>Result code for this API operation.  Possible values are S_OK, E_INVALIDARG, or E_FAIL.</returns>
 STDAPI HCHttpCallRequestGetRequestBodyBytes(
-    _In_ hc_call_handle_t call,
+    _In_ HCCallHandle call,
     _Outptr_result_bytebuffer_maybenull_(*requestBodySize) const uint8_t** requestBodyBytes,
     _Out_ uint32_t* requestBodySize
     ) HC_NOEXCEPT;
@@ -123,7 +123,7 @@ STDAPI HCHttpCallRequestGetRequestBodyBytes(
 /// <param name="requestBody">The UTF-8 encoded request body of the HTTP call</param>
 /// <returns>Result code for this API operation.  Possible values are S_OK, E_INVALIDARG, or E_FAIL.</returns>
 STDAPI HCHttpCallRequestGetRequestBodyString(
-    _In_ hc_call_handle_t call,
+    _In_ HCCallHandle call,
     _Outptr_ const char** requestBody
     ) HC_NOEXCEPT;
 
@@ -135,7 +135,7 @@ STDAPI HCHttpCallRequestGetRequestBodyString(
 /// <param name="headerValue">UTF-8 encoded request header value for the HTTP call</param>
 /// <returns>Result code for this API operation.  Possible values are S_OK, E_INVALIDARG, or E_FAIL.</returns>
 STDAPI HCHttpCallRequestGetHeader(
-    _In_ hc_call_handle_t call,
+    _In_ HCCallHandle call,
     _In_z_ const char* headerName,
     _Out_ const char** headerValue
     ) HC_NOEXCEPT;
@@ -147,7 +147,7 @@ STDAPI HCHttpCallRequestGetHeader(
 /// <param name="numHeaders">the number of request headers in the HTTP call</param>
 /// <returns>Result code for this API operation.  Possible values are S_OK, E_INVALIDARG, or E_FAIL.</returns>
 STDAPI HCHttpCallRequestGetNumHeaders(
-    _In_ hc_call_handle_t call,
+    _In_ HCCallHandle call,
     _Out_ uint32_t* numHeaders
     ) HC_NOEXCEPT;
 
@@ -161,7 +161,7 @@ STDAPI HCHttpCallRequestGetNumHeaders(
 /// <param name="headerValue">UTF-8 encoded request header value for the HTTP call</param>
 /// <returns>Result code for this API operation.  Possible values are S_OK, E_INVALIDARG, or E_FAIL.</returns>
 STDAPI HCHttpCallRequestGetHeaderAtIndex(
-    _In_ hc_call_handle_t call,
+    _In_ HCCallHandle call,
     _In_ uint32_t headerIndex,
     _Out_ const char** headerName,
     _Out_ const char** headerValue
@@ -175,7 +175,7 @@ STDAPI HCHttpCallRequestGetHeaderAtIndex(
 /// <param name="retryAllowed">If retry is allowed for this HTTP call</param>
 /// <returns>Result code for this API operation.  Possible values are S_OK, E_INVALIDARG, or E_FAIL.</returns>
 STDAPI HCHttpCallRequestGetRetryAllowed(
-    _In_opt_ hc_call_handle_t call,
+    _In_opt_ HCCallHandle call,
     _Out_ bool* retryAllowed
     ) HC_NOEXCEPT;
 
@@ -187,7 +187,7 @@ STDAPI HCHttpCallRequestGetRetryAllowed(
 /// <param name="retryAfterCacheId">ID number of this REST endpoint used to cache the Retry-After header for fast fail.  1-1000 are reserved for XSAPI</param>
 /// <returns>Result code for this API operation.  Possible values are S_OK, E_INVALIDARG, or E_FAIL.</returns>
 STDAPI HCHttpCallRequestGetRetryCacheId(
-    _In_ hc_call_handle_t call,
+    _In_ HCCallHandle call,
     _Out_ uint32_t* retryAfterCacheId
     ) HC_NOEXCEPT;
 
@@ -199,7 +199,7 @@ STDAPI HCHttpCallRequestGetRetryCacheId(
 /// <param name="timeoutInSeconds">the timeout for this HTTP call.</param>
 /// <returns>Result code for this API operation.  Possible values are S_OK, E_INVALIDARG, or E_FAIL.</returns>
 STDAPI HCHttpCallRequestGetTimeout(
-    _In_opt_ hc_call_handle_t call,
+    _In_opt_ HCCallHandle call,
     _Out_ uint32_t* timeoutInSeconds
     ) HC_NOEXCEPT;
 
@@ -229,7 +229,7 @@ STDAPI HCHttpCallRequestGetTimeout(
 /// <param name="retryDelayInSeconds">The retry delay in seconds</param>
 /// <returns>Result code for this API operation.  Possible values are S_OK, E_INVALIDARG, or E_FAIL.</returns>
 STDAPI HCHttpCallRequestGetRetryDelay(
-    _In_opt_ hc_call_handle_t call,
+    _In_opt_ HCCallHandle call,
     _In_ uint32_t* retryDelayInSeconds
     ) HC_NOEXCEPT;
 
@@ -252,7 +252,7 @@ STDAPI HCHttpCallRequestGetRetryDelay(
 /// <param name="timeoutWindowInSeconds">The timeout window in seconds</param>
 /// <returns>Result code for this API operation.  Possible values are S_OK, E_INVALIDARG, or E_FAIL.</returns>
 STDAPI HCHttpCallRequestGetTimeoutWindow(
-    _In_opt_ hc_call_handle_t call,
+    _In_opt_ HCCallHandle call,
     _Out_ uint32_t* timeoutWindowInSeconds
     ) HC_NOEXCEPT;
 
@@ -270,7 +270,7 @@ STDAPI HCHttpCallRequestGetTimeoutWindow(
 /// <param name="enableAssertsForThrottling">True if assert are enabled if throttled</param>
 /// <returns>Result code for this API operation.  Possible values are S_OK, E_INVALIDARG, or E_FAIL.</returns>
 STDAPI HCHttpCallRequestGetAssertsForThrottling(
-    _In_opt_ hc_call_handle_t call,
+    _In_opt_ HCCallHandle call,
     _Out_ bool* enableAssertsForThrottling
     ) HC_NOEXCEPT;
 
@@ -287,7 +287,7 @@ STDAPI HCHttpCallRequestGetAssertsForThrottling(
 /// <param name="bodySize">The length in bytes of the body being set.</param>
 /// <returns>Result code for this API operation.  Possible values are S_OK, E_INVALIDARG, E_OUTOFMEMORY, or E_FAIL.</returns>
 STDAPI HCHttpCallResponseSetResponseBodyBytes(
-    _In_ hc_call_handle_t call,
+    _In_ HCCallHandle call,
     _In_reads_bytes_(bodySize) const uint8_t* bodyBytes,
     _In_ size_t bodySize
     ) HC_NOEXCEPT;
@@ -299,7 +299,7 @@ STDAPI HCHttpCallResponseSetResponseBodyBytes(
 /// <param name="statusCode">the HTTP status code of the HTTP call response</param>
 /// <returns>Result code for this API operation.  Possible values are S_OK, E_INVALIDARG, or E_FAIL.</returns>
 STDAPI HCHttpCallResponseSetStatusCode(
-    _In_ hc_call_handle_t call,
+    _In_ HCCallHandle call,
     _In_ uint32_t statusCode
     ) HC_NOEXCEPT;
 
@@ -311,7 +311,7 @@ STDAPI HCHttpCallResponseSetStatusCode(
 /// <param name="platformNetworkErrorCode">The platform specific network error code of the HTTP call to be used for logging / debugging</param>
 /// <returns>Result code for this API operation.  Possible values are S_OK, E_INVALIDARG, or E_FAIL.</returns>
 STDAPI HCHttpCallResponseSetNetworkErrorCode(
-    _In_ hc_call_handle_t call,
+    _In_ HCCallHandle call,
     _In_ HRESULT networkErrorCode,
     _In_ uint32_t platformNetworkErrorCode
     ) HC_NOEXCEPT;
@@ -324,7 +324,7 @@ STDAPI HCHttpCallResponseSetNetworkErrorCode(
 /// <param name="headerValue">UTF-8 encoded response header value for the HTTP call</param>
 /// <returns>Result code for this API operation.  Possible values are S_OK, E_INVALIDARG, E_OUTOFMEMORY, or E_FAIL.</returns>
 STDAPI HCHttpCallResponseSetHeader(
-    _In_ hc_call_handle_t call,
+    _In_ HCCallHandle call,
     _In_z_ const char* headerName,
     _In_z_ const char* headerValue
     ) HC_NOEXCEPT;
@@ -349,7 +349,7 @@ typedef HRESULT
 (CALLBACK* HCWebSocketConnectFunction)(
     _In_z_ const char* uri,
     _In_z_ const char* subProtocol,
-    _In_ hc_websocket_handle_t websocket,
+    _In_ HCWebsocketHandle websocket,
     _Inout_ XAsyncBlock* asyncBlock
     );
 
@@ -362,7 +362,7 @@ typedef HRESULT
 /// <returns>Result code for this API operation.  Possible values are S_OK, E_INVALIDARG, or E_FAIL.</returns>
 typedef HRESULT
 (CALLBACK* HCWebSocketSendMessageFunction)(
-    _In_ hc_websocket_handle_t websocket,
+    _In_ HCWebsocketHandle websocket,
     _In_z_ const char* message,
     _Inout_ XAsyncBlock* asyncBlock
     );
@@ -375,7 +375,7 @@ typedef HRESULT
 /// <returns>Result code for this API operation.  Possible values are S_OK, E_INVALIDARG, or E_FAIL.</returns>
 typedef HRESULT
 (CALLBACK* HCWebSocketDisconnectFunction)(
-    _In_ hc_websocket_handle_t websocket,
+    _In_ HCWebsocketHandle websocket,
     _In_ HCWebSocketCloseStatus closeStatus
     );
 
@@ -421,7 +421,7 @@ HCGetWebSocketFunctions(
 /// <returns>Result code for this API operation.  Possible values are S_OK, E_INVALIDARG, E_OUTOFMEMORY, or E_FAIL.</returns>
 STDAPI 
 HCWebSocketGetProxyUri(
-    _In_ hc_websocket_handle_t websocket,
+    _In_ HCWebsocketHandle websocket,
     _Out_ const char** proxyUri
     ) HC_NOEXCEPT;
 
@@ -434,7 +434,7 @@ HCWebSocketGetProxyUri(
 /// <returns>Result code for this API operation.  Possible values are S_OK, E_INVALIDARG, E_OUTOFMEMORY, or E_FAIL.</returns>
 STDAPI 
 HCWebSocketGetHeader(
-    _In_ hc_websocket_handle_t websocket,
+    _In_ HCWebsocketHandle websocket,
     _In_z_ const char* headerName,
     _Out_ const char** headerValue
     ) HC_NOEXCEPT;
@@ -447,7 +447,7 @@ HCWebSocketGetHeader(
 /// <returns>Result code for this API operation.  Possible values are S_OK, E_INVALIDARG, or E_FAIL.</returns>
 STDAPI 
 HCWebSocketGetNumHeaders(
-    _In_ hc_websocket_handle_t websocket,
+    _In_ HCWebsocketHandle websocket,
     _Out_ uint32_t* numHeaders
     ) HC_NOEXCEPT;
 
@@ -462,7 +462,7 @@ HCWebSocketGetNumHeaders(
 /// <returns>Result code for this API operation.  Possible values are S_OK, E_INVALIDARG, or E_FAIL.</returns>
 STDAPI 
 HCWebSocketGetHeaderAtIndex(
-    _In_ hc_websocket_handle_t websocket,
+    _In_ HCWebsocketHandle websocket,
     _In_ uint32_t headerIndex,
     _Out_ const char** headerName,
     _Out_ const char** headerValue

Include/httpClient/httpProvider.h

@@ -17,7 +17,7 @@
 /// <param name="call">The handle of the mock HTTP call</param>
 /// <returns>Result code for this API operation.  Possible values are S_OK, E_INVALIDARG, or E_FAIL.</returns>
 STDAPI HCMockCallCreate(
-    _Out_ hc_mock_call_handle* call
+    _Out_ HCMockCallHandle* call
     ) HC_NOEXCEPT;
 
 
@@ -58,7 +58,7 @@ STDAPI HCMockCallCreate(
 /// </param>
 /// <returns>Result code for this API operation.  Possible values are S_OK, E_INVALIDARG, E_OUTOFMEMORY, or E_FAIL.</returns>
 STDAPI HCMockAddMock(
-    _In_ hc_mock_call_handle call,
+    _In_ HCMockCallHandle call,
     _In_opt_z_ const char* method,
     _In_opt_z_ const char* url,
     _In_reads_bytes_opt_(requestBodySize) const uint8_t* requestBodyBytes,
@@ -84,7 +84,7 @@ STDAPI HCMockClearMocks() HC_NOEXCEPT;
 /// <param name="bodySize">The length in bytes of the body being set.</param>
 /// <returns>Result code for this API operation.  Possible values are S_OK, E_INVALIDARG, E_OUTOFMEMORY, or E_FAIL.</returns>
 STDAPI HCMockResponseSetResponseBodyBytes(
-    _In_ hc_mock_call_handle call,
+    _In_ HCMockCallHandle call,
     _In_reads_bytes_(bodySize) const uint8_t* bodyBytes,
     _In_ uint32_t bodySize
     ) HC_NOEXCEPT;
@@ -96,7 +96,7 @@ STDAPI HCMockResponseSetResponseBodyBytes(
 /// <param name="statusCode">the HTTP status code of the HTTP call response</param>
 /// <returns>Result code for this API operation.  Possible values are S_OK, E_INVALIDARG, or E_FAIL.</returns>
 STDAPI HCMockResponseSetStatusCode(
-    _In_ hc_mock_call_handle call,
+    _In_ HCMockCallHandle call,
     _In_ uint32_t statusCode
     ) HC_NOEXCEPT;
 
@@ -108,7 +108,7 @@ STDAPI HCMockResponseSetStatusCode(
 /// <param name="platformNetworkErrorCode">The platform specific network error code of the HTTP call to be used for logging / debugging</param>
 /// <returns>Result code for this API operation.  Possible values are S_OK, E_INVALIDARG, or E_FAIL.</returns>
 STDAPI HCMockResponseSetNetworkErrorCode(
-    _In_ hc_mock_call_handle call,
+    _In_ HCMockCallHandle call,
     _In_ HRESULT networkErrorCode,
     _In_ uint32_t platformNetworkErrorCode
     ) HC_NOEXCEPT;
@@ -121,7 +121,7 @@ STDAPI HCMockResponseSetNetworkErrorCode(
 /// <param name="headerValue">UTF-8 encoded response header value for the HTTP call</param>
 /// <returns>Result code for this API operation.  Possible values are S_OK, E_INVALIDARG, E_OUTOFMEMORY, or E_FAIL.</returns>
 STDAPI HCMockResponseSetHeader(
-    _In_ hc_mock_call_handle call,
+    _In_ HCMockCallHandle call,
     _In_z_ const char* headerName,
     _In_z_ const char* headerValue
     ) HC_NOEXCEPT;

Include/httpClient/mock.h

@@ -376,11 +376,11 @@ typedef struct _LIST_ENTRY {
 #define E_HC_CONNECT_ALREADY_CALLED     MAKE_E_HC(0x5005)
 #define E_HC_NO_NETWORK                 MAKE_E_HC(0x5006)
 
-typedef uint32_t hc_memory_type;
-typedef struct HC_WEBSOCKET* hc_websocket_handle_t;
-typedef struct HC_CALL* hc_call_handle_t;
-typedef struct HC_CALL* hc_mock_call_handle;
-typedef struct HC_PERFORM_ENV* hc_perform_env;
+typedef uint32_t HCMemoryType;
+typedef struct HC_WEBSOCKET* HCWebsocketHandle;
+typedef struct HC_CALL* HCCallHandle;
+typedef struct HC_CALL* HCMockCallHandle;
+typedef struct HC_PERFORM_ENV* HCPerformEnv;
 
 // Error codes from https://www.iana.org/assignments/websocket/websocket.xml#close-code-number
 typedef enum HCWebSocketCloseStatus

Include/httpClient/pal.h

@@ -36,12 +36,12 @@ libHttpClient provides a platform abstraction layer for HTTP and WebSocket, and
 1. Optionally call HCMemSetFunctions() to control memory allocations
 1. Call HCInitialize()
 1. Optionally call HCSettingsSet*()
-1. Call HCHttpCallCreate() to create a new hc_call_handle_t
-1. Call HCHttpCallRequestSet*() to prepare the hc_call_handle_t
-1. Call HCHttpCallPerform() to perform an HTTP call using the hc_call_handle_t.  
+1. Call HCHttpCallCreate() to create a new HCCallHandle
+1. Call HCHttpCallRequestSet*() to prepare the HCCallHandle
+1. Call HCHttpCallPerform() to perform an HTTP call using the HCCallHandle.  
 1. The perform call is asynchronous, so the work will be done on a background thread which calls DispatchAsyncQueue( ..., AsyncQueueCallbackType_Work ).  The results will return to the callback on the thread that calls DispatchAsyncQueue( ..., AsyncQueueCallbackType_Completion ).
-1. Call HCHttpCallResponseGet*() to get the HTTP response of the hc_call_handle_t
-1. Call HCHttpCallCloseHandle() to cleanup the hc_call_handle_t
+1. Call HCHttpCallResponseGet*() to get the HTTP response of the HCCallHandle
+1. Call HCHttpCallCloseHandle() to cleanup the HCCallHandle
 1. Repeat 4-8 for each new HTTP call
 1. Call HCCleanup() at shutdown before your memory manager set in step 1 is shutdown
 

README.md

@@ -56,7 +56,7 @@ win32_handle g_completionReadyHandle;
 #define TICKS_PER_SECOND 10000000i64
 
 void STDAPIVCALLTYPE PerformCallWithCurl(
-    _In_ hc_call_handle_t call,
+    _In_ HCCallHandle call,
     _Inout_ AsyncBlock* asyncBlock
     );
 
@@ -223,7 +223,7 @@ void HttpTestApp::MainPage::StartBackgroundThread()
     }
 }
 
-std::vector<std::vector<std::string>> ExtractAllHeaders(_In_ hc_call_handle_t call)
+std::vector<std::vector<std::string>> ExtractAllHeaders(_In_ HCCallHandle call)
 {
     uint32_t numHeaders = 0;
     HCHttpCallResponseGetNumHeaders(call, &numHeaders);
@@ -295,7 +295,7 @@ void HttpTestApp::MainPage::Button_Click(Platform::Object^ sender, Windows::UI::
     std::string requestMethod = to_utf8string(TextboxMethod->Text->Data());
     std::string requestUrl = to_utf8string(TextboxURL->Text->Data());
 
-    hc_call_handle_t call = nullptr;
+    HCCallHandle call = nullptr;
     HCHttpCallCreate(&call);
     HCHttpCallRequestSetUrl(call, requestMethod.c_str(), requestUrl.c_str());
     HCHttpCallRequestSetRequestBodyString(call, requestBody.c_str());
@@ -321,7 +321,7 @@ void HttpTestApp::MainPage::Button_Click(Platform::Object^ sender, Windows::UI::
         std::string responseString;
         std::string errMessage;
 
-        hc_call_handle_t call = static_cast<hc_call_handle_t>(asyncBlock->context);
+        HCCallHandle call = static_cast<HCCallHandle>(asyncBlock->context);
         HCHttpCallResponseGetNetworkErrorCode(call, &errCode, &platErrCode);
         HCHttpCallResponseGetStatusCode(call, &statusCode);
         HCHttpCallResponseGetResponseString(call, &str);

Samples/UWP-CustomHttpImplWithCurl/MainPage.xaml.cpp

@@ -67,7 +67,7 @@ std::wstring to_wstring(const std::string &value)
 }
 
 void STDAPIVCALLTYPE PerformCallWithCurl(
-    _In_ hc_call_handle_t call,
+    _In_ HCCallHandle call,
     _Inout_ AsyncBlock* asyncBlock
     )
 {

Samples/UWP-CustomHttpImplWithCurl/PerformWithCurl.cpp

@@ -202,7 +202,7 @@ void HttpTestApp::MainPage::StartBackgroundThread()
     }
 }
 
-std::vector<std::vector<std::string>> ExtractAllHeaders(_In_ hc_call_handle_t call)
+std::vector<std::vector<std::string>> ExtractAllHeaders(_In_ HCCallHandle call)
 {
     uint32_t numHeaders = 0;
     HCHttpCallResponseGetNumHeaders(call, &numHeaders);
@@ -280,7 +280,7 @@ void HttpTestApp::MainPage::Button_Click(Platform::Object^ sender, Windows::UI::
     HCTraceSetClientCallback(TraceCallback);
     HCTraceSetTraceToDebugger(true);
 
-    hc_call_handle_t call = nullptr;
+    HCCallHandle call = nullptr;
     HCHttpCallCreate(&call);
     HCHttpCallRequestSetUrl(call, requestMethod.c_str(), requestUrl.c_str());
     HCHttpCallRequestSetTimeoutWindow(call, timeoutInt);
@@ -308,7 +308,7 @@ void HttpTestApp::MainPage::Button_Click(Platform::Object^ sender, Windows::UI::
         std::string responseString;
         std::string errMessage;
 
-        hc_call_handle_t call = static_cast<hc_call_handle_t>(asyncBlock->context);
+        HCCallHandle call = static_cast<HCCallHandle>(asyncBlock->context);
         HCHttpCallResponseGetNetworkErrorCode(call, &errCode, &platErrCode);
         HCHttpCallResponseGetStatusCode(call, &statusCode);
         HCHttpCallResponseGetResponseString(call, &str);