Skip to content

Latest commit

 

History

History
48 lines (47 loc) · 1.64 KB

bz_BaseURLHandler.md

File metadata and controls

48 lines (47 loc) · 1.64 KB
since category constructor functions
2.4.0
Objects
returnType description name params
void
This method is called when a URL job completes successfully.
URLDone
dataType description name
const char*
The URL the original request was sent to.
URL
dataType description name
const void*
The incoming body of the request as a `const char*`, cast as needed.
data
dataType description name
unsigned int
The string length of the incoming body.
size
dataType description name
bool
Will always be `true`.
complete
returnType description name params
void
This method is called if the URL request times out.
URLTimeout
dataType description name
const char*
The URL this request is coming from
URL
dataType description name
int
Will always be `1`.
errorCode
returnType description name params
void
This method is called if the URL request fails.
URLError
dataType description name
const char*
The URL this request is coming from
URL
dataType description name
int
Will always be `1`.
errorCode
dataType description name
const char*
Will always be `"Error"`.
errorString

The base class that is used for bz_addURLJob handlers. The URLDone method is a pure virtual function and must be implemented by any classes extending this base class.