diff options
author | Michael Drake <tlsa@netsurf-browser.org> | 2014-08-26 17:59:19 +0100 |
---|---|---|
committer | Michael Drake <tlsa@netsurf-browser.org> | 2014-08-26 17:59:19 +0100 |
commit | b7b70a3ca89f2bce90dac363967b31477794b157 (patch) | |
tree | d964670aae908aa9c471433fefc36bccd3945faa /content/fetchers.h | |
parent | 5bed515e68b22024992fe1cda336c7b8afa78c6f (diff) | |
parent | 2eb86b9096add2523d1c3a46264abfa420ff6a88 (diff) | |
download | netsurf-b7b70a3ca89f2bce90dac363967b31477794b157.tar.gz netsurf-b7b70a3ca89f2bce90dac363967b31477794b157.tar.bz2 |
Merge branch 'master' of git://git.netsurf-browser.org/netsurf
Diffstat (limited to 'content/fetchers.h')
-rw-r--r-- | content/fetchers.h | 21 |
1 files changed, 16 insertions, 5 deletions
diff --git a/content/fetchers.h b/content/fetchers.h index d123de986..95034bbff 100644 --- a/content/fetchers.h +++ b/content/fetchers.h @@ -16,7 +16,9 @@ * along with this program. If not, see <http://www.gnu.org/licenses/>. */ -/** \file content/fetchers.h +/** + * \file content/fetchers.h + * * Interface for fetchers factory. */ @@ -34,6 +36,15 @@ struct fetch; * Fetcher operations API * * These are the operations a fetcher must implement. + * + * Each fetcher is called once for initialisaion and finalisation. + * The poll entry point will be called to allow all active fetches to progress. + * The flow of a fetch operation is: + * URL is checked for aceptability. + * setup with all applicable data. + * start is called before teh first poll + * after completion or abort it is freed + * */ struct fetcher_operation_table { /** @@ -44,7 +55,7 @@ struct fetcher_operation_table { bool (*initialise)(lwc_string *scheme); /** - * can this fetcher accept a url. + * Can this fetcher accept a url. * * \param url the URL to check * \return true if the fetcher can handle the url else false. @@ -80,7 +91,7 @@ struct fetcher_operation_table { void (*poll)(lwc_string *scheme); /** - * finalise the fetcher. + * Finalise the fetcher. */ void (*finalise)(lwc_string *scheme); }; @@ -97,9 +108,9 @@ nserror fetcher_add(lwc_string *scheme, const struct fetcher_operation_table *op /** - * Initialise the fetchers. + * Initialise all registered fetchers. * - * @return NSERROR_OK or error code + * \return NSERROR_OK or error code */ nserror fetcher_init(void); |