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

FreeBSD Manual Pages

  
 
  

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

NAME
       mrecv - receives	a message

SYNOPSIS
	      #include <libdill.h>

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

DESCRIPTION
       This  function receives message from a socket.  It is a blocking	opera-
       tion that unblocks only after entire message is received.  There	is  no
       such thing as partial receive.  Either entire message is	received or no
       message at all.

       s: The socket.

       buf: Buffer to receive the message 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 size of the  received  message,
       in  bytes.  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 EMSGSIZE: The data won't fit into the supplied	buffer.

       o ENOTSUP: The handle does not support this operation.

       o EPIPE:	Closed connection.

       o ETIMEDOUT: Deadline was reached.

EXAMPLE
	      char msg[100];
	      ssize_t msgsz = mrecv(s, msg, sizeof(msg), -1);

SEE ALSO
       mrecvl(3) msend(3) msendl(3) now(3)

libdill								      MRECV(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=mrecv&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help