This manual page is part of Xcode Tools version 3.2

To obtain these tools:

If you are running a version of Xcode Tools other than 3.2, view the documentation locally:

  • In Xcode

  • In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

  • For more information about the manual page format, see the manual page for manpages(5).

  • For more information about this technology, look for other documentation in the Apple Reference Library.

  • For general information about writing shell scripts, read Shell Scripting Primer.



SSL_set_shutdown(3)                                OpenSSL                               SSL_set_shutdown(3)



NAME
       SSL_set_shutdown, SSL_get_shutdown - manipulate shutdown state of an SSL connection

SYNOPSIS
        #include <openssl/ssl.h>

        void SSL_set_shutdown(SSL *ssl, int mode);

        int SSL_get_shutdown(const SSL *ssl);

DESCRIPTION
       SSL_set_shutdown() sets the shutdown state of ssl to mode.

       SSL_get_shutdown() returns the shutdown mode of ssl.

NOTES
       The shutdown state of an ssl connection is a bitmask of:

       0   No shutdown setting, yet.

       SSL_SENT_SHUTDOWN
           A "close notify" shutdown alert was sent to the peer, the connection is being considered closed
           and the session is closed and correct.

       SSL_RECEIVED_SHUTDOWN
           A shutdown alert was received form the peer, either a normal "close notify" or a fatal error.

       SSL_SENT_SHUTDOWN and SSL_RECEIVED_SHUTDOWN can be set at the same time.

       The shutdown state of the connection is used to determine the state of the ssl session. If the
       session is still open, when SSL_clear(3) or SSL_free(3) is called, it is considered bad and removed
       according to RFC2246.  The actual condition for a correctly closed session is SSL_SENT_SHUTDOWN
       (according to the TLS RFC, it is acceptable to only send the "close notify" alert but to not wait for
       the peer's answer, when the underlying connection is closed).  SSL_set_shutdown() can be used to set
       this state without sending a close alert to the peer (see SSL_shutdown(3)).

       If a "close notify" was received, SSL_RECEIVED_SHUTDOWN will be set, for setting SSL_SENT_SHUTDOWN
       the application must however still call SSL_shutdown(3) or SSL_set_shutdown() itself.

RETURN VALUES
       SSL_set_shutdown() does not return diagnostic information.

       SSL_get_shutdown() returns the current setting.

SEE ALSO
       ssl(3), SSL_shutdown(3), SSL_CTX_set_quiet_shutdown(3), SSL_clear(3), SSL_free(3)



0.9.8                                            2009-04-03                              SSL_set_shutdown(3)

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors
Report errors in the content of this documentation to the OpenSSL project by sending email to [email protected].
Bug reports
Report bugs in the functionality of the described tool or API to Apple through Bug Reporter and to the OpenSSL project by sending email to [email protected].
Formatting problems
Report formatting mistakes in the online version of these pages with the feedback links below.