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

FreeBSD Manual Pages

  
 
  

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

NAME
       brecv - receives	data from a bytestream socket

SYNOPSIS
	      #include <libdill.h>

	      int brecv(
		  int s,
		  void*	buf,
		  size_t len,
		  int64_t deadline);

DESCRIPTION
       This function receives data from	a bytestream socket.  It is a blocking
       operation that unblocks only after the requested	amount of data is  re-
       ceived.	 There is no such thing	as partial receive.  If	a problem, in-
       cluding timeout,	occurs while receiving the data, an error is  returned
       to the user and the socket cannot be used for receiving from that point
       on.

       If buf is NULL, len bytes will be received but  they  will  be  dropped
       rather than returned to the user.

       s: The socket.

       buf: Buffer to receive the data to.

       len: Size of the	buffer,	in bytes.

       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.

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 EBUSY:	The handle is currently	being used by a	different coroutine.

       o ECANCELED: Current coroutine was canceled.

       o ECONNRESET: Broken connection.

       o EINVAL: Invalid argument.

       o ENOTSUP: The handle does not support this operation.

       o EPIPE:	Closed connection.

       o ETIMEDOUT: Deadline was reached.

EXAMPLE
	      char msg[100];
	      int rc = brecv(s,	msg, sizeof(msg), -1);

SEE ALSO
       brecvl(3) bsend(3) bsendl(3) now(3)

libdill								      BRECV(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=brecv&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help