man7.org > Linux > man-pages

Linux/UNIX system programming training

gnutls_bye(3) — Linux manual page

NAME | SYNOPSIS | ARGUMENTS | DESCRIPTION | RETURNS | REPORTING BUGS | COPYRIGHT | SEE ALSO | COLOPHON 

gnutls_bye(3)                    gnutls                    gnutls_bye(3)

NAME         top

       gnutls_bye - API function

SYNOPSIS         top

       #include <gnutls/gnutls.h>

       int gnutls_bye(gnutls_session_t session, gnutls_close_request_t
       how);

ARGUMENTS         top

       gnutls_session_t session
                   is a gnutls_session_t type.

       gnutls_close_request_t how
                   is an integer

DESCRIPTION         top

       Terminates the current TLS/SSL connection. The connection should
       have been initiated using gnutls_handshake().   how should be one
       of GNUTLS_SHUT_RDWR, GNUTLS_SHUT_WR.

       In case of GNUTLS_SHUT_RDWR the TLS session gets terminated and
       further receives and sends will be disallowed.  If the return
       value is zero you may continue using the underlying transport
       layer. GNUTLS_SHUT_RDWR sends an alert containing a close request
       and waits for the peer to reply with the same message.

       In case of GNUTLS_SHUT_WR the TLS session gets terminated and
       further sends will be disallowed. In order to reuse the
       connection you should wait for an EOF from the peer.
       GNUTLS_SHUT_WR sends an alert containing a close request.

       Note that not all implementations will properly terminate a TLS
       connection.  Some of them, usually for performance reasons, will
       terminate only the underlying transport layer, and thus not
       distinguishing between a malicious party prematurely terminating
       the connection and normal termination.

       This function may also return GNUTLS_E_AGAIN or
       GNUTLS_E_INTERRUPTED; cf.  gnutls_record_get_direction().

RETURNS         top

       GNUTLS_E_SUCCESS on success, or an error code, see function
       documentation for entire semantics.

REPORTING BUGS         top

       Report bugs to <bugs@gnutls.org>.
       Home page: https://www.gnutls.org

COPYRIGHT         top

       Copyright © 2001-2023 Free Software Foundation, Inc., and others.
       Copying and distribution of this file, with or without
       modification, are permitted in any medium without royalty
       provided the copyright notice and this notice are preserved.

SEE ALSO         top

       The full documentation for gnutls is maintained as a Texinfo
       manual.  If the /usr/share/doc/gnutls/ directory does not contain
       the HTML form visit

       https://www.gnutls.org/manual/

COLOPHON         top

       This page is part of the GnuTLS (GnuTLS Transport Layer Security
       Library) project.  Information about the project can be found at
       ⟨http://www.gnutls.org/⟩.  If you have a bug report for this
       manual page, send it to bugs@gnutls.org.  This page was obtained
       from the tarball gnutls-3.8.2.tar.xz fetched from
       ⟨http://www.gnutls.org/download.html⟩ on 2023-12-22.  If you
       discover any rendering problems in this HTML version of the page,
       or you believe there is a better or more up-to-date source for
       the page, or you have corrections or improvements to the
       information in this COLOPHON (which is not part of the original
       manual page), send a mail to man-pages@man7.org

gnutls                            3.8.2                    gnutls_bye(3)

HTML rendering created 2023-12-22 by Michael Kerrisk, author of The Linux Programming Interface.

For details of in-depth Linux/UNIX system programming training courses that I teach, look here.

Hosting by jambit GmbH.

Cover of TLPI