This generic and the associated method for a CURLHandle
allows one to reset the state of the Curl object
to its default state. This is convenient if we want
to reuse the same connection, but want to ensure
that it is in a particular state.
Unfortunately, we cannot query the state of different
fields in an existing Curl handle and so we need
to be able to reset the state and then update it with
any particular settings we would have liked to keep.
Usage
reset(x, ...)
Arguments
x
the object to be reset. For our method, this is an object of
class CURLHandle.
...
additional arguments for methods
Value
Methods typically return the updated version of the
object passed to it. This allows the caller to assign
the new result to the same variable rather than
relying on mutating the content of the object in place.
In other words, the object should not be treated as a reference
but a new object with the updated contents should be returned.
Details
This calls the C routine curl_easy_reset in libcurl.