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

  
 
  

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

NAME
     tcp_done - half-closes a TCP connection

SYNOPSIS
	    #include <libdill.h>

	    int tcp_done(
		int s,
		int64_t deadline);

DESCRIPTION
     TCP  protocol  is a reliable bytestream protocol for transporting data over
     network.  It is defined in RFC 793.

     This function closes the outbound half of TCP connection.	Technically,  it
     sends  a FIN packet to the peer.  This will, in turn, cause the peer to get
     EPIPE error after it has received all the data.

     s: The TCP connection handle.

     deadline: A point in time when the operation should time out, in  millisec-
     onds.  Use the now function to get your current point in time.  0 means im-
     mediate  timeout, i.e., perform the operation if possible or return 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 --disable-sock-
     ets 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
     * EBADF: Invalid handle.

     * ECANCELED: Current coroutine was canceled.

     * ENOTSUP: The handle does not support this operation.

     * EPIPE: The connection was already half-closed.

     * ETIMEDOUT: Deadline was reached.

EXAMPLE
	    struct ipaddr addr;
	    ipaddr_local(&addr, NULL, 5555, 0);
	    int ls = tcp_listen(&addr, 10);
	    int s = tcp_accept(ls, NULL, -1);
	    bsend(s, "ABC", 3, -1);
	    char buf[3];
	    brecv(s, buf, sizeof(buf), -1);
	    tcp_close(s);
	    tcp_close(ls);

SEE ALSO
     brecv(3)	brecvl(3)   bsend(3)   bsendl(3)  now(3)  tcp_accept(3)  tcp_ac-
     cept_mem(3) tcp_close(3)  tcp_connect(3)  tcp_connect_mem(3)  tcp_fromfd(3)
     tcp_fromfd_mem(3)	tcp_listen(3)  tcp_listen_mem(3)  tcp_listener_fromfd(3)
     tcp_listener_fromfd_mem(3)

libdill 							     TCP_DONE(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=tcp_done&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help