ContentsIndex
PreviousUpNext
HTTP & HTTPS
Topics | Functions | Structs, Records, Enums | Types
Description

This API enables the use of the HTTPS protocol.

Introduction

The basic flow of using HTTPS is as follows:

  1. Register the callback function by calling vm_https_register_context_and_callback().
  2. Configure a dedicated channel for HTTPS requests by calling vm_https_set_channel().
  3. Send an HTTPS request by calling vm_https_send_request().
  4. Read the content by calling vm_https_read_content().
Limitation

The maximum concurrent https requests you can make is four with unique request IDs. 

 

 

Group
Functions
Function 
Description 
This function sends a request to cancel an incomplete WSP/HTTP request. 
This function handles continuous content post of a HTTPS request. 
This function sends a request to continue to read HTTP/WSP reply content. 
This function registers a callback function. 
This function sends a HTTP/WSP request. It's an extended version of the function vm_https_send_request. CALLS 
Sends an HTTP/WSP request. 
Configure a dedicated channel for HTTP/WSP requests. An channel can be configured to use a proxy while use_proxy is true. When use_proxy is true, This function configures a dedicated channel for HTTP/WSP requests. A channel can be configured to use a proxy while use_proxy is true. When use_proxy is true, prx_ip, prx_port, username, and password will be used to communicate with the proxy server, thus prx_ip cannot be 0.0.0.0 and if the prx_port value is 0 it means the default proxy port is 8080. When the conn_type is HTTPS_CONN_TYPE_WSP_CO or HTTPS_CONN_TYPE_WSP_CL, the use_proxy is true by default. However, if the... more 
This function sends unset channel request information to HTTPS. 
Structs, Records, Enums
Struct, Record, Enum 
Description 
HTTPS callbacks struct 
This enum indicates the HTTPS character set. 
The vm_http_content_t is the unit of multipart. 
This enum specifies the data format in a given HTTPS request or response. 
HTTPS method constants 
HTTPS request options 
Protocol constants 
This enum indicates HTTPS ready status 
This is the structure used for vm_https_send_req_ext. 
This enum indicates the result and error code of a request. 
Types
Type 
Description 
This function responds to the cancel request. 
This function responds to the post request. 
Response to the vm_https_read_content. The sequence_number must be the same as the one in the corresponding vm_https_read_content. The more flag is used to indicate if the application needs to use This function responds to the vm_https_read_content. The sequence_number must be the same as the one in the corresponding vm_https_read_content. The more flag is used to indicate if the application needs to use vm_https_read_content to retrieve the remaining content. 
This function responds to release of all requests. 
Response to the HTTPS request. New_url is used to hold the new URL that was used to retrieve this reply if the original request was This function responds to the HTTPS request. New_url is used to hold the new URL that was used to retrieve this reply if the original request was redirected. If the reply_type is VM_HTTPS_DATA_TYPE_BUFFER, then the more flag is used to indicate if the application needs to use vm_https_read_content to retrieve the remaining content. 
Response to the channel configuration request. If the result is successful then the channel ID will be used in the HTTP/WSP request. This function responds to the channel configuration request. If the result is successful, then the channel ID will be used in the HTTP/WSP request. 
This function responds to status query request. It's reserved for future development. 
Notifying the application about an HTTPS agent termination. The application should clear all information at its end, and start again. This function sends notification on an HTTPS agent termination to the application. Upon receiving the notification, the application should clear all information at termination, and start again. 
Response to channel remove request. If the channel ID requested is invalid or some pending request of this channel exists, an error will come back as a result. This function responds to channel removal request. If the channel ID requested is invalid or if there's a pending request of this channel, an error will incurr. 
Links
Created with a commercial version of Doc-O-Matic. In order to make this message disappear you need to register this software. If you have problems registering this software please contact us at support@toolsfactory.com.