Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
HTTP_RECVFIELD(3)	   libdill Library Functions	     HTTP_RECVFIELD(3)

NAME
       http_recvfield -	receives HTTP field from the peer

SYNOPSIS
	      #include <libdill.h>

	      int http_recvfield(
		  int s,
		  char*	name,
		  size_t namelen,
		  char*	value,
		  size_t valuelen,
		  int64_t deadline);

DESCRIPTION
       WARNING:	 This  is experimental functionality and the API may change in
       the future.

       HTTP is an application-level protocol described in RFC 7230.  This  im-
       plementation  handles  only  the	 request/response  exchange.  Whatever
       comes after that	must be	handled	by a different protocol.

       This function receives an HTTP field from the peer.

       s: HTTP socket handle.

       name: Buffer to store name of the field.

       namelen:	Size of	the name buffer.

       value: Buffer to	store value of the field.

       valuelen: Size of the value buffer.

       deadline: A point in time when the operation should time	out,  in  mil-
       liseconds.   Use	the now	function to get	your current point in time.  0
       means immediate timeout,	i.e., perform the operation if possible	or re-
       turn  without  blocking	if  not.  -1 means no deadline,	i.e., the call
       will block forever if the operation cannot be performed.

       This function is	not available  if  libdill  is	compiled  with	--dis-
       able-sockets option.

RETURN VALUE
       In case of success the function returns 0.  In case of error it returns
       -1 and sets errno to one	of the values below.

ERRORS
       o EBADF:	Invalid	handle.

       o ECANCELED: Current coroutine was canceled.

       o ECONNRESET: Broken connection.

       o EINVAL: Invalid argument.

       o EMSGSIZE: The data won't fit into the supplied	buffer.

       o ENOTSUP: The handle does not support this operation.

       o EPIPE:	There are no more fields to receive.

       o ETIMEDOUT: Deadline was reached.

EXAMPLE
	      int s = tcp_connect(&addr, -1);
	      s	= http_attach(s);
	      http_sendrequest(s, "GET", "/", -1);
	      http_sendfield(s,	"Host",	"www.example.org", -1);
	      http_done(s, -1);
	      char reason[256];
	      http_recvstatus(s, reason, sizeof(reason), -1);
	      while(1) {
		  char name[256];
		  char value[256];
		  int rc = http_recvfield(s, name, sizeof(name), value,	sizeof(value), -1);
		  if(rc	== -1 && errno == EPIPE) break;
	      }
	      s	= http_detach(s, -1);
	      tcp_close(s);

SEE ALSO
       http_attach(3)	 http_attach_mem(3)    http_detach(3)	  http_done(3)
       http_recvrequest(3)	   http_recvstatus(3)	     http_sendfield(3)
       http_sendrequest(3) http_sendstatus(3) now(3)

libdill							     HTTP_RECVFIELD(3)

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | ERRORS | EXAMPLE | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=http_recvfield&sektion=3&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help