Document fetchReqHTTP().

Submitted by:	Farhan Khan <khanzf@gmail.com>
Reviewed by:	0mp
MFC after:	1 week
Differential Revision:	https://reviews.freebsd.org/D18788
This commit is contained in:
Mark Johnston 2019-08-28 17:01:28 +00:00
parent 88cc62e5a5
commit f4e05cc55d
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/head/; revision=351573
3 changed files with 23 additions and 3 deletions

View file

@ -68,6 +68,7 @@ MLINKS+= fetch.3 fetchPutFTP.3
MLINKS+= fetch.3 fetchPutFile.3
MLINKS+= fetch.3 fetchPutHTTP.3
MLINKS+= fetch.3 fetchPutURL.3
MLINKS+= fetch.3 fetchReqHTTP.3
MLINKS+= fetch.3 fetchStat.3
MLINKS+= fetch.3 fetchStatFTP.3
MLINKS+= fetch.3 fetchStatFile.3

View file

@ -26,7 +26,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd March 18, 2016
.Dd August 28, 2019
.Dt FETCH 3
.Os
.Sh NAME
@ -53,6 +53,7 @@
.Nm fetchPutHTTP ,
.Nm fetchStatHTTP ,
.Nm fetchListHTTP ,
.Nm fetchReqHTTP ,
.Nm fetchXGetFTP ,
.Nm fetchGetFTP ,
.Nm fetchPutFTP ,
@ -112,6 +113,8 @@
.Ft struct url_ent *
.Fn fetchListHTTP "struct url *u" "const char *flags"
.Ft FILE *
.Fn fetchReqHTTP "struct url *u" "const char *method" "const char *flags" "const char *content_type" "const char *body"
.Ft FILE *
.Fn fetchXGetFTP "struct url *u" "struct url_stat *us" "const char *flags"
.Ft FILE *
.Fn fetchGetFTP "struct url *u" "const char *flags"
@ -355,9 +358,10 @@ and password "anonymous@<hostname>".
.Sh HTTP SCHEME
The
.Fn fetchXGetHTTP ,
.Fn fetchGetHTTP
and
.Fn fetchGetHTTP ,
.Fn fetchPutHTTP
and
.Fn fetchReqHTTP
functions implement the HTTP/1.1 protocol.
With a little luck, there is
even a chance that they comply with RFC2616 and RFC2617.
@ -387,6 +391,18 @@ will send a conditional
HTTP header to only fetch the content if it is newer than
.Va ims_time .
.Pp
The function
.Fn fetchReqHTTP
can be used to make requests with an arbitrary HTTP verb,
including POST, DELETE, CONNECT, OPTIONS, TRACE or PATCH.
This can be done by setting the argument
.Fa method
to the intended verb, such as
.Ql POST ,
and
.Fa body
to the content.
.Pp
Since there seems to be no good way of implementing the HTTP PUT
method in a manner consistent with the rest of the
.Nm fetch

View file

@ -2093,6 +2093,9 @@ fetchListHTTP(struct url *url __unused, const char *flags __unused)
return (NULL);
}
/*
* Arbitrary HTTP verb and content requests
*/
FILE *
fetchReqHTTP(struct url *URL, const char *method, const char *flags,
const char *content_type, const char *body)