ACurl::Builder Class Reference

Public Member Functions
	Builder (AString url)
	Builder (const Builder &)=delete
Builder &	withWriteCallback (WriteCallback callback)
	Called on server -> client data received (download).
Builder &	withMultipart (const AFormMultipart &multipart)
	Add multipart data.
Builder &	withBody (ReadCallback callback)
	Called on client -> server data requested (upload).
Builder &	withInputStream (_< IInputStream > inputStream)
	Called on client -> server data requested (upload).
Builder &	withTimeout (std::chrono::seconds timeout)
	Specifies acceptable response time.
Builder &	withBody (std::string contents)
	Like withBody with callback, but wrapped with string.
Builder &	withHeaderCallback (HeaderCallback headerCallback)
	Called on header received.
Builder &	withErrorCallback (ErrorCallback callback)
Builder &	withDestinationBuffer (aui::constraint::avoid_copy< AByteBuffer > dst)
Builder &	withOutputStream (_< IOutputStream > dst)
Builder &	throwExceptionOnError (bool throwExceptionOnError) noexcept
Builder &	withRanges (size_t begin, size_t end)
	Sets: Accept-Ranges: begin-end (download part of the file)
Builder &	withRanges (size_t begin)
	Sets: Accept-Ranges: begin-end (download part of the file)
Builder &	withLowSpeedLimit (size_t speed)
	Set the average transfer speed in bytes per that the transfer should be below during 'low speed time' seconds to consider it to be too slow and abort.
Builder &	withLowSpeedTime (std::chrono::seconds duration)
	Duration that the transfer speed should be below the 'low speed limit' to consider it to be too slow and abort.
Builder &	withHttpVersion (Http version)
Builder &	withUpload (bool upload)
Builder &	withCustomRequest (const AString &v)
Builder &	withOnSuccess (std::function< void(ACurl &)> onSuccess)
template<aui::invocable OnSuccess>
Builder &	withOnSuccess (OnSuccess &&onSuccess)
Builder &	withMethod (Method method) noexcept
	Sets HTTP method to the query.
Builder &	withParams (const AVector< std::pair< AString, AString > > &params)
	Sets HTTP params to the query.
Builder &	withParams (AString params) noexcept
	Sets HTTP params to the query.
Builder &	withHeaders (AVector< AString > headers)
_unique< IInputStream >	toInputStream ()
	Makes input stream from curl builder.
Response	runBlocking ()
	Constructs ACurl object and performs curl request in blocking mode. Use toFuture() instead if possible.
AFuture< Response >	runAsync ()
	Constructs ACurl object and performs curl request in global ACurlMulti.
AFuture< Response >	runAsync (ACurlMulti &curlMulti)
	Constructs ACurl object and performs curl request in specified ACurlMulti.

Member Function Documentation

runAsync() [1/2]

AFuture< ACurl::Response > ACurl::Builder::runAsync

(

)

Constructs ACurl object and performs curl request in global ACurlMulti.

Returns

Response future.

runAsync() [2/2]

AFuture< ACurl::Response > ACurl::Builder::runAsync

(

ACurlMulti &

curlMulti

)

Constructs ACurl object and performs curl request in specified ACurlMulti.

Returns

Response future.

runBlocking()

ACurl::Response ACurl::Builder::runBlocking

(

)

Constructs ACurl object and performs curl request in blocking mode. Use toFuture() instead if possible.

Exceptions

AIOException

toInputStream()

_unique< IInputStream > ACurl::Builder::toInputStream

(

)

Makes input stream from curl builder.

Note

creates async task where curl's loop lives in.

Exceptions

AIOException

Returns

input stream

withBody()

Builder & ACurl::Builder::withBody ( ReadCallback callback )

inline

Called on client -> server data requested (upload).

Parameters

callback

callback to call.

Returns

this

withErrorCallback()

Builder & ACurl::Builder::withErrorCallback ( ErrorCallback callback )

inline

Note

Also disables throwing exception on error

withHeaderCallback()

Builder & ACurl::Builder::withHeaderCallback ( HeaderCallback headerCallback )

inline

Called on header received.

Parameters

headerCallback

callback to call.

Returns

this

withInputStream()

Builder & ACurl::Builder::withInputStream ( _< IInputStream > inputStream )

inline

Called on client -> server data requested (upload).

Parameters

inputStream

input stream to get data to upload from.

Returns

this

withLowSpeedLimit()

ACurl::Builder & ACurl::Builder::withLowSpeedLimit

(

size_t

speed

)

Set the average transfer speed in bytes per that the transfer should be below during 'low speed time' seconds to consider it to be too slow and abort.

Parameters

speed

threshold speed (bytes per second).

withLowSpeedTime()

ACurl::Builder & ACurl::Builder::withLowSpeedTime

(

std::chrono::seconds

duration

)

Duration that the transfer speed should be below the 'low speed limit' to consider it to be too slow and abort.

Parameters

duration

duration

withMethod()

Builder & ACurl::Builder::withMethod ( Method method )

inlinenoexcept

Sets HTTP method to the query.

GET is by default.

withMultipart()

Builder & ACurl::Builder::withMultipart ( const AFormMultipart & multipart )

inline

Add multipart data.

This function implies adding Content-Type: multipart and it's boundaries, setting withBody with multipart data.

withParams() [1/2]

Builder & ACurl::Builder::withParams ( AString params )

inlinenoexcept

Sets HTTP params to the query.

In GET, the params are encoded and appended to the url.

In POST, this value is used instead of readCallback (withBody).

withParams() [2/2]

ACurl::Builder & ACurl::Builder::withParams

(

const AVector< std::pair< AString, AString > > &

params

)

Sets HTTP params to the query.

Parameters

params

params map in key,value pairs.

In GET, the params are encoded and appended to the url.

In POST, this value is used instead of readCallback (withBody).

withRanges() [1/2]

Builder & ACurl::Builder::withRanges ( size_t begin )

inline

Sets: Accept-Ranges: begin-end (download part of the file)

Parameters

begin

start index of the part

Returns

this

withRanges() [2/2]

ACurl::Builder & ACurl::Builder::withRanges	(	size_t	begin,
		size_t	end )

Sets: Accept-Ranges: begin-end (download part of the file)

Parameters

begin	start index of the part
end	end index of the part.

Returns

this

withTimeout()

ACurl::Builder & ACurl::Builder::withTimeout

(

std::chrono::seconds

timeout

)

Specifies acceptable response time.

Returns

this

withWriteCallback()

Builder & ACurl::Builder::withWriteCallback ( WriteCallback callback )

inline

Called on server -> client data received (download).

Parameters

callback

callback to call.

Returns

this

See also

withDestinationBuffer

---

The documentation for this class was generated from the following files:

• aui.curl/src/AUI/Curl/ACurl.h
• aui.curl/src/AUI/Curl/ACurl.cpp