httpClient

Functions

Function Description
HCAddCallRoutedHandler Adds a callback to be invoked on intermediate http calls in order to debug or trace the traffic.
HCAddWebSocketRoutedHandler Adds a callback to be invoked on websocket traffic in order to debug or trace the traffic.
HCCleanup Immediately reclaims all resources associated with the library. If you called HCMemSetFunctions(), call this before shutting down your app's memory manager.
HCCleanupAsync Reclaims all resources associated with the library. If you called HCMemSetFunctions(), call this before shutting down your app's memory manager.
HCGetLibVersion Returns the version of the library.
HCGetWebSocketConnectResult Gets the result for HCGetWebSocketConnectResult.
HCGetWebSocketSendMessageResult Gets the result from HCWebSocketSendMessage.
HCHttpCallCloseHandle Decrements the reference count on the call object.
HCHttpCallCreate Creates an HTTP call handle.
HCHttpCallDuplicateHandle Duplicates the HCCallHandle object.
HCHttpCallGetId Returns a unique uint64_t which identifies this HTTP call object.
HCHttpCallGetRequestUrl Gets the request url for the HTTP call.
HCHttpCallPerformAsync Perform HTTP call using the HCCallHandle.
HCHttpCallRequestSetHeader Set a request header for the HTTP call.
HCHttpCallRequestSetRequestBodyBytes Set the request body bytes of the HTTP call. This API operation is mutually exclusive with HCHttpCallRequestSetRequestBodyReadFunction and will result in any custom read callbacks that were previously set on this call handle to be ignored.
HCHttpCallRequestSetRequestBodyReadFunction Sets a custom callback function that will be used to read the request body when the HTTP call is performed. If a custom read callback is used, any request body data previously set by HCHttpCallRequestSetRequestBodyBytes or HCHttpCallRequestSetRequestBodyString is ignored making these API operations mutually exclusive.
HCHttpCallRequestSetRequestBodyString Set the request body string of the HTTP call. This API operation is mutually exclusive with HCHttpCallRequestSetRequestBodyReadFunction and will result in any custom read callbacks that were previously set on this call handle to be ignored.
HCHttpCallRequestSetRetryAllowed Sets if retry is allowed for this HTTP call.
HCHttpCallRequestSetRetryCacheId ID number of this REST endpoint used to cache the Retry-After header for fast fail.
HCHttpCallRequestSetRetryDelay Sets the HTTP retry delay in seconds. The default and minimum delay is 2 seconds.
HCHttpCallRequestSetSSLValidation Enables or disables SSL server certificate validation for this specific HTTP call.
HCHttpCallRequestSetTimeout Sets the timeout for this HTTP call.
HCHttpCallRequestSetTimeoutWindow Sets the HTTP timeout window in seconds.
HCHttpCallRequestSetUrl Sets the url and method for the HTTP call.
HCHttpCallResponseGetHeader Get a response header for the HTTP call for a given header name.
HCHttpCallResponseGetHeaderAtIndex Gets the response headers at specific zero based index in the HTTP call.
HCHttpCallResponseGetNetworkErrorCode Get the network error code of the HTTP call.
HCHttpCallResponseGetNumHeaders Gets the number of response headers in the HTTP call.
HCHttpCallResponseGetPlatformNetworkErrorMessage Get the platform network error message of the HTTP call.
HCHttpCallResponseGetResponseBodyBytes Get the response body buffer of the HTTP call. This API operation will fail if a custom write callback was set on this call handle using HCHttpCallResponseSetResponseBodyWriteFunction.
HCHttpCallResponseGetResponseBodyBytesSize Get the response body buffer size of the HTTP call. This API operation will fail if a custom write callback was set on this call handle using HCHttpCallResponseSetResponseBodyWriteFunction.
HCHttpCallResponseGetResponseString Get the response body string of the HTTP call. This API operation will fail if a custom write callback was set on this call handle using HCHttpCallResponseSetResponseBodyWriteFunction.
HCHttpCallResponseGetStatusCode Get the HTTP status code of the HTTP call response.
HCHttpCallResponseSetResponseBodyWriteFunction Sets a custom callback function that will be used to write the response body when the HTTP call is performed. Using a custom write callback will cause subsequent calls to HCHttpCallResponseGetResponseBodyBytesSize, HCHttpCallResponseGetResponseBodyBytes, and HCHttpCallGetResponseBodyString to fail as these are mutually exclusive.
HCHttpCallSetTracing Enables or disables tracing for this specific HTTP call.
HCInitialize Initializes the library instance.
HCMemGetFunctions Gets the memory hook functions to allow callers to control route memory allocations to their own memory manager.
HCMemSetFunctions Optionally sets the memory hook functions to allow callers to control route memory allocations to their own memory manager.
HCRemoveCallRoutedHandler Removes a previously added HCCallRoutedHandler.
HCRemoveWebSocketRoutedHandler Removes a previously added HCWebSocketRoutedHandler.
HCSetGlobalProxy Manually sets an explicit proxy address.
HCWebSocketCloseHandle Decrements the reference count on the WebSocket object.
HCWebSocketConnectAsync Connects to the WebSocket.
HCWebSocketCreate Creates an WebSocket handle.
HCWebSocketDisconnect Disconnects / closes the WebSocket.
HCWebSocketDuplicateHandle Increments the reference count on the call object.
HCWebSocketGetEventFunctions Gets the WebSocket functions to allow callers to respond to incoming messages and WebSocket close events.
HCWebSocketSendBinaryMessageAsync Send binary message to the WebSocket.
HCWebSocketSendMessageAsync Send message the WebSocket
HCWebSocketSetHeader Set a header for the WebSocket.
HCWebSocketSetProxyDecryptsHttps Allows proxy server to decrypt and inspect traffic; should be used only for debugging purposes This must be called after calling HCWebSocketSetProxyUri. Only applies to Win32 non-GDK builds
HCWebSocketSetProxyUri Set the proxy URI for the WebSocket.

Structures

Structure Description
HCInitArgs Used to wrap the JavaVM and ApplicationContext on Android devices.
HCInitArgs Dummy init args used by non-Android devices.
WebSocketCompletionResult Used by HCWebSocketConnectAsync() and HCWebSocketSendMessageAsync().