libcURL.cURLSession

libcURL.cURLSession

Class Declaration

 Protected Class cURLSession

Remarks

This class is a generic libcURL client. Use one of the overloaded Perform methods to begin processing a transfer.

This class can perform both synchronous and asynchronous requests, depending on which version of Perform is called. Synchronous versions return True on success. Asynchronous methods do not return a value.

Synchronous requests will be performed on the calling thread; asynchronous requests will be performed on the main event loop. The event loop must be allowed to run in order for asynchronous transfers to operate.

This class uses one EasyHandle and one MultiHandle to perform all transfers, and only one transfer can be processed at a time. Attempting to initiate a new transfer before the previous transfer completes will raise a cURLException with error number CURLM_ADDED_ALREADY (7).

The EasyHandle is configured with options that are not the defaults for EasyHandle:

• FollowRedirects is set to True.
• AutoReferer is set to True.
• CA_ListFile or CA_List is set to Mozilla's CA list.
• If compression is available then HTTP requests will request compression.
• UseErrorBuffer is set to True. The ErrorBuffer provides human-friendly descriptions for most errors.

Event Definitions

• DebugMessage
• Error
• TransferComplete
• Progress

Methods

• Abort
• Close
• Constructor
• GetCookie
• GetDownloadedData
• GetInfo
• GetOption
• GetResponseHeaders
• GetStatusCode
• IsOptionSet
• Pause
• Perform
• Reset
• Resume
• SetCookie
• SetOption
• SetRequestMethod
• SetUploadData

Properties

• Cookies As libcURL.CookieEngine
• EasyHandle As libcURL.EasyHandle
• EasyItem As libcURL.EasyHandle
• HTTPAuthenticationMethod As libcURL.HTTPAuthMethods
• HTTPVersion As libcURL.HTTPVersion
• IsSSLCertOK As Boolean
• IsTransferComplete As Boolean
• LastError As Integer
• LastErrorMessage As String
• LastStatusCode As Integer
• Password As String
• Proxy As libcURL.ProxyEngine
• RequestHeaders As libcURL.RequestHeaderEngine
• ResponseHeaders As libcURL.ResponseHeaderEngine
• Username As String
• Yield As Boolean

See also

• cURLClient