← Back to branch summary

~ubuntu-branches/ubuntu/precise/openssl098/precise

« back to all changes in this revision

Viewing changes to doc/ssl/SSL_state_string.pod

  • Committer: Bazaar Package Importer
  • Author(s): Kurt Roeckx
  • Date: 2011-03-23 19:50:31 UTC
  • Revision ID: james.westby@ubuntu.com-20110323195031-6h9crj4bymhhr8b8
Tags: upstream-0.9.8o
Import upstream version 0.9.8o

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/ssl/SSL_state_string.pod
 
1
=pod
 
2
 
 
3
=head1 NAME
 
4
 
 
5
SSL_state_string, SSL_state_string_long - get textual description of state of an SSL object
 
6
 
 
7
=head1 SYNOPSIS
 
8
 
 
9
 #include <openssl/ssl.h>
 
10
 
 
11
 const char *SSL_state_string(const SSL *ssl);
 
12
 const char *SSL_state_string_long(const SSL *ssl);
 
13
 
 
14
=head1 DESCRIPTION
 
15
 
 
16
SSL_state_string() returns a 6 letter string indicating the current state
 
17
of the SSL object B<ssl>.
 
18
 
 
19
SSL_state_string_long() returns a string indicating the current state of
 
20
the SSL object B<ssl>.
 
21
 
 
22
=head1 NOTES
 
23
 
 
24
During its use, an SSL objects passes several states. The state is internally
 
25
maintained. Querying the state information is not very informative before
 
26
or when a connection has been established. It however can be of significant
 
27
interest during the handshake.
 
28
 
 
29
When using non-blocking sockets, the function call performing the handshake
 
30
may return with SSL_ERROR_WANT_READ or SSL_ERROR_WANT_WRITE condition,
 
31
so that SSL_state_string[_long]() may be called.
 
32
 
 
33
For both blocking or non-blocking sockets, the details state information
 
34
can be used within the info_callback function set with the
 
35
SSL_set_info_callback() call.
 
36
 
 
37
=head1 RETURN VALUES
 
38
 
 
39
Detailed description of possible states to be included later.
 
40
 
 
41
=head1 SEE ALSO
 
42
 
 
43
L<ssl(3)|ssl(3)>, L<SSL_CTX_set_info_callback(3)|SSL_CTX_set_info_callback(3)>
 
44
 
 
45
=cut