secure/lib/libssl/man/SSL_want.3

   1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.19)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 'br\}
  42 .\"
  43 .\" Escape single quotes in literal strings from groff's Unicode transform.
  44 .ie \n(.g .ds Aq \(aq
  45 .el       .ds Aq '
  46 .\"
  47 .\" If the F register is turned on, we'll generate index entries on stderr for
  48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  50 .\" output yourself in some meaningful fashion.
  51 .ie \nF \{\
  52 .    de IX
  53 .    tm Index:\\$1\t\\n%\t"\\$2"
  54 ..
  55 .    nr % 0
  56 .    rr F
  57 .\}
  58 .el \{\
  59 .    de IX
  60 ..
  61 .\}
  62 .\"
  63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  65 .    \" fudge factors for nroff and troff
  66 .if n \{\
  67 .    ds #H 0
  68 .    ds #V .8m
  69 .    ds #F .3m
  70 .    ds #[ \f1
  71 .    ds #] \fP
  72 .\}
  73 .if t \{\
  74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  75 .    ds #V .6m
  76 .    ds #F 0
  77 .    ds #[ \&
  78 .    ds #] \&
  79 .\}
  80 .    \" simple accents for nroff and troff
  81 .if n \{\
  82 .    ds ' \&
  83 .    ds ` \&
  84 .    ds ^ \&
  85 .    ds , \&
  86 .    ds ~ ~
  87 .    ds /
  88 .\}
  89 .if t \{\
  90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  96 .\}
  97 .    \" troff and (daisy-wheel) nroff accents
  98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 105 .ds ae a\h'-(\w'a'u*4/10)'e
 106 .ds Ae A\h'-(\w'A'u*4/10)'E
 107 .    \" corrections for vroff
 108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 110 .    \" for low resolution devices (crt and lpr)
 111 .if \n(.H>23 .if \n(.V>19 \
 112 \{\
 113 .    ds : e
 114 .    ds 8 ss
 115 .    ds o a
 116 .    ds d- d\h'-1'\(ga
 117 .    ds D- D\h'-1'\(hy
 118 .    ds th \o'bp'
 119 .    ds Th \o'LP'
 120 .    ds ae ae
 121 .    ds Ae AE
 122 .\}
 123 .rm #[ #] #H #V #F C
 124 .\" ========================================================================
 125 .\"
 126 .IX Title "SSL_want 3"
 127 .TH SSL_want 3 "2012-04-26" "1.0.1b" "OpenSSL"
 128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 129 .\" way too many mistakes in technical documents.
 130 .if n .ad l
 131 .nh
 132 .SH "NAME"
 133 SSL_want, SSL_want_nothing, SSL_want_read, SSL_want_write, SSL_want_x509_lookup \- obtain state information TLS/SSL I/O operation
 134 .SH "SYNOPSIS"
 135 .IX Header "SYNOPSIS"
 136 .Vb 1
 137 \& #include <openssl/ssl.h>
 138 \&
 139 \& int SSL_want(const SSL *ssl);
 140 \& int SSL_want_nothing(const SSL *ssl);
 141 \& int SSL_want_read(const SSL *ssl);
 142 \& int SSL_want_write(const SSL *ssl);
 143 \& int SSL_want_x509_lookup(const SSL *ssl);
 144 .Ve
 145 .SH "DESCRIPTION"
 146 .IX Header "DESCRIPTION"
 147 \&\fISSL_want()\fR returns state information for the \s-1SSL\s0 object \fBssl\fR.
 148 .PP
 149 The other SSL_want_*() calls are shortcuts for the possible states returned
 150 by \fISSL_want()\fR.
 151 .SH "NOTES"
 152 .IX Header "NOTES"
 153 \&\fISSL_want()\fR examines the internal state information of the \s-1SSL\s0 object. Its
 154 return values are similar to that of \fISSL_get_error\fR\|(3).
 155 Unlike \fISSL_get_error\fR\|(3), which also evaluates the
 156 error queue, the results are obtained by examining an internal state flag
 157 only. The information must therefore only be used for normal operation under
 158 non-blocking I/O. Error conditions are not handled and must be treated
 159 using \fISSL_get_error\fR\|(3).
 160 .PP
 161 The result returned by \fISSL_want()\fR should always be consistent with
 162 the result of \fISSL_get_error\fR\|(3).
 163 .SH "RETURN VALUES"
 164 .IX Header "RETURN VALUES"
 165 The following return values can currently occur for \fISSL_want()\fR:
 166 .IP "\s-1SSL_NOTHING\s0" 4
 167 .IX Item "SSL_NOTHING"
 168 There is no data to be written or to be read.
 169 .IP "\s-1SSL_WRITING\s0" 4
 170 .IX Item "SSL_WRITING"
 171 There are data in the \s-1SSL\s0 buffer that must be written to the underlying
 172 \&\fB\s-1BIO\s0\fR layer in order to complete the actual SSL_*() operation.
 173 A call to \fISSL_get_error\fR\|(3) should return
 174 \&\s-1SSL_ERROR_WANT_WRITE\s0.
 175 .IP "\s-1SSL_READING\s0" 4
 176 .IX Item "SSL_READING"
 177 More data must be read from the underlying \fB\s-1BIO\s0\fR layer in order to
 178 complete the actual SSL_*() operation.
 179 A call to \fISSL_get_error\fR\|(3) should return
 180 \&\s-1SSL_ERROR_WANT_READ\s0.
 181 .IP "\s-1SSL_X509_LOOKUP\s0" 4
 182 .IX Item "SSL_X509_LOOKUP"
 183 The operation did not complete because an application callback set by
 184 \&\fISSL_CTX_set_client_cert_cb()\fR has asked to be called again.
 185 A call to \fISSL_get_error\fR\|(3) should return
 186 \&\s-1SSL_ERROR_WANT_X509_LOOKUP\s0.
 187 .PP
 188 \&\fISSL_want_nothing()\fR, \fISSL_want_read()\fR, \fISSL_want_write()\fR, \fISSL_want_x509_lookup()\fR
 189 return 1, when the corresponding condition is true or 0 otherwise.
 190 .SH "SEE ALSO"
 191 .IX Header "SEE ALSO"
 192 \&\fIssl\fR\|(3), \fIerr\fR\|(3), \fISSL_get_error\fR\|(3)