/
HTTPc API

HTTPc API

Owned by Former user (Deleted)
Last updated: Mar 02, 2015Version comment

This section provides a reference to the µC/HTTP-client API. The following information is provided for each of those services:

  • A brief description
  • The function prototype
  • The filename of the source code
  • A description of the arguments passed to the function
  • A description of the returned values
  • Specific notes and warnings on using the service

 

Function NameDescription
General API
HTTPc_Init()Initializes the HTTP Client Suite.
HTTPc_ConnClr()Clears the HTTPc Connection object passed by the Application.
HTTPc_ConnSetParam()Setups a parameter related to an HTTPc Connection object.
HTTPc_ConnOpen()Starts or queues a socket opening and connecting to the remote HTTP server.
HTTPc_ConnClose()Performs or queues a socket closing.
HTTPc_ReqClr()Clears the HTTPc Request object passed by the Application.
HTTPc_ReqSetParam()Setups a parameter related to an HTTPc Request object.
HTTPc_ReqSend()Performs or queues the sending of an HTTP request.
HTTP Form submission API
HTTPc_FormAppFormat()Formats an HTTP application type's form from a form field table.
HTTPc_FormMultipartFormat()Formats an HTTP multipart type's form from a form field table.
HTTPc_FormAddKeyVal()Add a new HTTPc_KEY_VAL object to the form table.
HTTPc_FormAddKeyValExt()Add a new HTTPc_KEY_VAL_EXT object to the form table.
HTTPc_FormAddFile()Add a new HTTPc_MULTIPART_FILE object to the form table.
WebSocket API
HTTPc_WebSockUpgrade()Upgrade a HTTP client connection to a WebSocket.
HTTPc_WebSockSendSend a WebSocket message.
HTTPc_WebSockSetParam()Setups a parameter related to the given HTTPc WebSocket Object.
HTTPc_WebSockMsgSetParam()Setups a parameter related to the given HTTPc WebSocket Message Object.
HTTPc_WebSockClr()Clears the HTTPc WebSocket Object passed as argument.
HTTPc_WebSockMsgClr()Clears the HTTPc WebSocket Message Object passed as argument.
HTTPc_WebSockFmtCloseMsg()Format a Close Frame.

Related content