Bz BaseURLHandler - Revision history

Constitution: spelling

2013-06-02T00:17:52Z

spelling

← Older revision		Revision as of 00:17, 2 June 2013
Line 14:		Line 14:
	This is the base class for callbacks from [[bz_addURLJob]]. It is used to return info about a URL request back to the calling plug-in.		This is the base class for callbacks from [[bz_addURLJob]]. It is used to return info about a URL request back to the calling plug-in.

	Plugins should derive there own callback class from this class and implement ~~there~~ own versions of the virtual methods that they require.		Plugins should derive there own callback class from this class and implement their own versions of the virtual methods that they require.

	==Methods==		==Methods==

JeffM2501 at 21:04, 26 September 2008

2008-09-26T21:04:13Z

← Older revision		Revision as of 21:04, 26 September 2008
Line 1:		Line 1:
	{{BZFS_API_Doc}}{{BZFS_API_Class}}		{{BZFS_API_Doc}}{{BZFS_API_Class}}
	==Delcaration==		==Delcaration==
	class bz_BaseURLHandler		class bz_BaseURLHandler
	{		{
	public:		public:
	bz_BaseURLHandler();		bz_BaseURLHandler();
	virtual ~bz_BaseURLHandler();		virtual ~bz_BaseURLHandler();
Line 9:		Line 9:
	virtual void timeout(const char* URL, int errorCode);		virtual void timeout(const char* URL, int errorCode);
	virtual void error(const char* URL, int errorCode, const char *errorString);		virtual void error(const char* URL, int errorCode, const char *errorString);
	}		}

	==Description==		==Description==

JeffM2501 at 21:03, 26 September 2008

2008-09-26T21:03:54Z

← Older revision		Revision as of 21:03, 26 September 2008
Line 9:		Line 9:
	virtual void timeout(const char* URL, int errorCode);		virtual void timeout(const char* URL, int errorCode);
	virtual void error(const char* URL, int errorCode, const char *errorString);		virtual void error(const char* URL, int errorCode, const char *errorString);
			}
	~~protected:~~
	~~int version;~~
	};

	==Description==		==Description==

JeffM2501: New page: {{BZFS_API_Doc}}{{BZFS_API_Class}} ==Delcaration== class bz_BaseURLHandler { public: bz_BaseURLHandler(); virtual ~bz_BaseURLHandler(); virtual void done(const char* URL, void * data...

2008-09-26T21:03:31Z

New page: {{BZFS_API_Doc}}{{BZFS_API_Class}} ==Delcaration== class bz_BaseURLHandler { public: bz_BaseURLHandler(); virtual ~bz_BaseURLHandler(); virtual void done(const char* URL, void * data...

New page

{{BZFS_API_Doc}}{{BZFS_API_Class}}
==Delcaration==
class bz_BaseURLHandler
{
public:
bz_BaseURLHandler();
virtual ~bz_BaseURLHandler();
virtual void done(const char* URL, void * data, unsigned int size, bool complete);
virtual void timeout(const char* URL, int errorCode);
virtual void error(const char* URL, int errorCode, const char *errorString);

protected:
int version;
};

==Description==
This is the base class for callbacks from [[bz_addURLJob]]. It is used to return info about a URL request back to the calling plug-in.

Plugins should derive there own callback class from this class and implement there own versions of the virtual methods that they require.

==Methods==
void done(const char* URL, void * data, unsigned int size, bool complete);
This is called as data is returned from the request. The complete paramater will be true on the last call for this job.

void timeout(const char* URL, int errorCode);
This is called when the URL job times out. This is usually because the server is offline

void error(const char* URL, int errorCode, const char *errorString);
This is called when the URL job errors out. This is usually because the URL is bad.