summaryrefslogtreecommitdiffstats
path: root/lib/libfetch/fetch.h
diff options
context:
space:
mode:
authordes <des@FreeBSD.org>1998-11-06 22:14:08 +0000
committerdes <des@FreeBSD.org>1998-11-06 22:14:08 +0000
commit93ce759c73e21f7ac6642b79a8e6146522b452aa (patch)
treef7eca0835b20fb3b31b3e447f024ef540f77afe0 /lib/libfetch/fetch.h
parentf2ceee99496bf97c1d2ffff9c8e7fd6a79474f2e (diff)
downloadFreeBSD-src-93ce759c73e21f7ac6642b79a8e6146522b452aa.zip
FreeBSD-src-93ce759c73e21f7ac6642b79a8e6146522b452aa.tar.gz
Second of a series of cleanups to libfetch.
This commit introduces the following features: a) the fetchStat*() functions, which return meta-information for a document, such as size, modification time, etc. b) the use of the com_err(3) facilities to report errors. It also fixes a bunch of style bugs and a few logic bugs and somewhat improves the man page. Changed files, in alphabetical order: Makefile: Don't generate macros in {ftp,http}err.c. Generate category fields for the error message lists. Compile the error table. Install fetch_err.h along with fetch.h. common.c: Remove the _netdb_errstring() macro, and add FETCH_ERR_NETDB to the error code in the _netdb_seterr() macro. Add categories to the _netdb_errlist table. Report errors through the Common Error library. common.h: Add the DEBUG macros. Add prototype for fetchConnect(). Remove the prototype for _fetch_errstring(), which is local to common.c Add a categroy field to struct fetcherr, and define constants for error categories. Define macros for _{url,netdb,ftp,http}_seterr(). errors.et: (new file) List error categories. fetch.3: Document the fetchStat*() functions. Move the "unimplemented functionality" comments from NOTES to BUGS. Document that applications which use libfetch must also use libcom_err, and list existing error codes. Undocument fetchLastErr{Code,String}. Remove the (empty) DIAGNOSTICS section. Mention Eugene Skepner in the AUTHORS section. fetch.c: Move the DEBUG macros to common.c Add fetchStat() and fetchStatURL(). Generate error messages for URL parser errors, and fix a minor bug in the parser. Use 'struct url' instead of 'url_t'. Remove fetchLastErr{Code,String}. fetch.h: Use 'struct url' instead of 'url_t', and remove the typedef. Define struct url_stat (used by fetchStat()). Add prototypes for fetchStat*(). Remove the declarations for fetchLastErr{Code,String}. Include fetch_err.h. fetch_err.et: (new file) Error table for libfetch. file.c: Add fetchStatFile(). Use 'struct url' instead of 'url_t'. ftp.c: Add fetchStatFTP(). Use 'struct url' instead of 'url_t'. Don't use fetchLastErrCode. ftp.errors: Add categories to all error messages. http.c: Add fetchStatHTTP(). Use 'struct url' instead of 'url_t'. Don't use fetchLastErr{Code,Text}. http.errors: Add categories to all error messages. Prompted by: jkh and Eugene Skepner Numerous sugestions from: Garett Wollman and Eugene Skepner
Diffstat (limited to 'lib/libfetch/fetch.h')
-rw-r--r--lib/libfetch/fetch.h58
1 files changed, 31 insertions, 27 deletions
diff --git a/lib/libfetch/fetch.h b/lib/libfetch/fetch.h
index cc39e36..286b253 100644
--- a/lib/libfetch/fetch.h
+++ b/lib/libfetch/fetch.h
@@ -25,7 +25,7 @@
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
- * $Id: fetch.h,v 1.4 1998/08/17 09:30:19 des Exp $
+ * $Id: fetch.h,v 1.5 1998/11/05 19:48:17 des Exp $
*/
#ifndef _FETCH_H_INCLUDED
@@ -34,47 +34,51 @@
#include <sys/param.h>
#include <stdio.h>
+#include <fetch_err.h>
+
#define _LIBFETCH_VER "libfetch/1.0"
#define URL_SCHEMELEN 16
#define URL_USERLEN 256
#define URL_PWDLEN 256
-struct url_s {
- char scheme[URL_SCHEMELEN+1];
- char user[URL_USERLEN+1];
- char pwd[URL_PWDLEN+1];
- char host[MAXHOSTNAMELEN+1];
- int port;
- char doc[2];
+struct url {
+ char scheme[URL_SCHEMELEN+1];
+ char user[URL_USERLEN+1];
+ char pwd[URL_PWDLEN+1];
+ char host[MAXHOSTNAMELEN+1];
+ int port;
+ char doc[2];
};
-typedef struct url_s url_t;
+struct url_stat {
+ off_t size;
+ time_t time;
+};
/* FILE-specific functions */
-FILE *fetchGetFile(url_t *, char *);
-FILE *fetchPutFile(url_t *, char *);
+FILE *fetchGetFile(struct url *, char *);
+FILE *fetchPutFile(struct url *, char *);
+int fetchStatFile(struct url *, struct url_stat *, char *);
/* HTTP-specific functions */
-char *fetchContentType(FILE *);
-FILE *fetchGetHTTP(url_t *, char *);
-FILE *fetchPutHTTP(url_t *, char *);
+char *fetchContentType(FILE *);
+FILE *fetchGetHTTP(struct url *, char *);
+FILE *fetchPutHTTP(struct url *, char *);
+int fetchStatHTTP(struct url *, struct url_stat *, char *);
/* FTP-specific functions */
-FILE *fetchGetFTP(url_t *, char *);
-FILE *fetchPutFTP(url_t *, char *);
+FILE *fetchGetFTP(struct url *, char *);
+FILE *fetchPutFTP(struct url *, char *);
+int fetchStatFTP(struct url *, struct url_stat *, char *);
/* Generic functions */
-int fetchConnect(char *, int);
-url_t *fetchParseURL(char *);
-void fetchFreeURL(url_t *);
-FILE *fetchGetURL(char *, char *);
-FILE *fetchPutURL(char *, char *);
-FILE *fetchGet(url_t *, char *);
-FILE *fetchPut(url_t *, char *);
-
-/* Error code and string */
-extern int fetchLastErrCode;
-extern const char *fetchLastErrText;
+struct url *fetchParseURL(char *);
+FILE *fetchGetURL(char *, char *);
+FILE *fetchPutURL(char *, char *);
+int fetchStatURL(char *, struct url_stat *, char *);
+FILE *fetchGet(struct url *, char *);
+FILE *fetchPut(struct url *, char *);
+int fetchStat(struct url *, struct url_stat *, char *);
#endif
OpenPOWER on IntegriCloud