Functions
| Function | Description |
|---|---|
| HCGetHttpCallPerformFunction | Returns the current HCCallPerformFunction callback which implements the HTTP perform function on the current platform. |
| HCGetWebSocketFunctions | Gets the functions that implement the WebSocket functions. |
| HCHttpCallGetContext | Gets the context pointer attached to this call object. |
| HCHttpCallRequestGetDynamicBytesWritten | Gets the dynamic request body size and bytes written for progress reporting. |
| HCHttpCallRequestGetHeader | Get a request header for the HTTP call for a given header name. |
| HCHttpCallRequestGetHeaderAtIndex | Gets the request headers at specific zero based index in the HTTP call. |
| HCHttpCallRequestGetMaxReceiveBufferSize | Gets the maximum receive buffer size for an HTTP call. Also declared in httpClient.h. |
| HCHttpCallRequestGetNumHeaders | Gets the number of request headers in the HTTP call. |
| HCHttpCallRequestGetProgressReportFunction | Gets the upload or download progress callback that the title set on an HTTP call. |
| HCHttpCallRequestGetRequestBodyBytes | Gets the request body bytes of the HTTP call. |
| HCHttpCallRequestGetRequestBodyReadFunction | Get the function used by the HTTP call to read the request body |
| HCHttpCallRequestGetRequestBodyString | Get the request body bytes of the HTTP call. |
| HCHttpCallRequestGetRetryAllowed | Gets if retry is allowed for this HTTP call. |
| HCHttpCallRequestGetRetryCacheId | Gets the ID number of this REST endpoint used to cache the Retry-After header for fast fail. |
| HCHttpCallRequestGetRetryDelay | Gets the HTTP retry delay in seconds. The default and minimum delay is 2 seconds. |
| HCHttpCallRequestGetTimeout | Gets the timeout for this HTTP call. |
| HCHttpCallRequestGetTimeoutWindow | Gets the HTTP timeout window in seconds. |
| HCHttpCallRequestGetUrl | Gets the URL and method for the HTTP call. |
| HCHttpCallResponseAddDynamicBytesWritten | Reports bytes written for an HTTP response body that has a dynamic size. |
| HCHttpCallResponseAppendResponseBodyBytes | Appends to the response body byte buffer of the HTTP call. If a custom write callback was previously set on this call handle using HCHttpCallResponseSetResponseBodyWriteFunction, this operation will fail as these are mutually exclusive. |
| HCHttpCallResponseGetDynamicBytesWritten | Gets the dynamic response body size and bytes written for progress reporting. |
| HCHttpCallResponseSetDynamicSize | Marks an HTTP call as having a dynamic-size response body for progress reporting. |
| HCHttpCallResponseSetHeader | Set a response header for the HTTP call. |
| HCHttpCallResponseSetHeaderWithLength | Set a response header for the HTTP call. |
| HCHttpCallResponseSetNetworkErrorCode | Set the network error code of the HTTP call. |
| HCHttpCallResponseSetPlatformNetworkErrorMessage | Set the platform network error message of the HTTP call. |
| HCHttpCallResponseSetResponseBodyBytes | Set the response body byte buffer of the HTTP call. If a custom write callback was previously set on this call handle using HCHttpCallResponseSetResponseBodyWriteFunction, this operation will fail as these are mutually exclusive. |
| HCHttpCallResponseGetResponseBodyWriteFunction | Get the function used by the HTTP call to write the response body. |
| HCHttpCallResponseSetStatusCode | Set the HTTP status code of the HTTP call response. |
| HCHttpCallSetContext | Sets the context pointer attached to this call object. |
| HCSetHttpCallPerformFunction | Optionally allows the caller to implement the HTTP perform function. |
| HCSetWebSocketFunctions | Optionally allows the caller to implement the WebSocket functions. |
| HCWebSocketGetHeader | Get a header for the WebSocket. |
| HCWebSocketGetHeaderAtIndex | Gets the headers at specific zero based index in the WebSocket. |
| HCWebSocketGetNumHeaders | Gets the number of headers in the WebSocket. |
| HCWebSocketGetPingInterval | Gets the keepalive ping interval set for a WebSocket. |
| HCWebSocketGetProxyUri | Get the proxy URI for the WebSocket. |
Callbacks
| Callback | Description |
|---|---|
| HCCallPerformFunction | The callback that performs an HTTP call for HCSetHttpCallPerformFunction. |
| HCWebSocketConnectFunction | The callback that implements the WebSocket connect operation for HCSetWebSocketFunctions. |
| HCWebSocketDisconnectFunction | The callback that implements closing a WebSocket for HCSetWebSocketFunctions. |
| HCWebSocketSendBinaryMessageFunction | The callback that implements sending a binary WebSocket message for HCSetWebSocketFunctions. |
| HCWebSocketSendMessageFunction | The callback that implements sending a text WebSocket message for HCSetWebSocketFunctions. |