external/bsd/libevent/man/bufferevent_ssl.h.3

   1 .TH "event2/bufferevent_ssl.h" 3 "Tue Jan 27 2015" "libevent" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 event2/bufferevent_ssl.h \-
   6 .PP
   7 OpenSSL support for bufferevents\&.
   8
   9 .SH SYNOPSIS
  10 .br
  11 .PP
  12 \fC#include <event2/event-config\&.h>\fP
  13 .br
  14 \fC#include <event2/bufferevent\&.h>\fP
  15 .br
  16 \fC#include <event2/util\&.h>\fP
  17 .br
  18
  19 .SS "Enumerations"
  20
  21 .in +1c
  22 .ti -1c
  23 .RI "enum \fBbufferevent_ssl_state\fP { \fBBUFFEREVENT_SSL_OPEN\fP = 0, \fBBUFFEREVENT_SSL_CONNECTING\fP = 1, \fBBUFFEREVENT_SSL_ACCEPTING\fP = 2 }"
  24 .br
  25 .RI "\fIThe state of an SSL object to be used when creating a new SSL bufferevent\&. \fP"
  26 .in -1c
  27 .SS "Functions"
  28
  29 .in +1c
  30 .ti -1c
  31 .RI "unsigned long \fBbufferevent_get_openssl_error\fP (struct \fBbufferevent\fP *bev)"
  32 .br
  33 .RI "\fIReturn the most recent OpenSSL error reported on an SSL bufferevent\&. \fP"
  34 .ti -1c
  35 .RI "struct \fBbufferevent\fP * \fBbufferevent_openssl_filter_new\fP (struct \fBevent_base\fP *base, struct \fBbufferevent\fP *underlying, struct ssl_st *ssl, enum \fBbufferevent_ssl_state\fP state, int options)"
  36 .br
  37 .RI "\fICreate a new SSL bufferevent to send its data over another bufferevent\&. \fP"
  38 .ti -1c
  39 .RI "struct ssl_st * \fBbufferevent_openssl_get_ssl\fP (struct \fBbufferevent\fP *bufev)"
  40 .br
  41 .RI "\fIReturn the underlying openssl SSL * object for an SSL bufferevent\&. \fP"
  42 .ti -1c
  43 .RI "struct \fBbufferevent\fP * \fBbufferevent_openssl_socket_new\fP (struct \fBevent_base\fP *base, \fBevutil_socket_t\fP fd, struct ssl_st *ssl, enum \fBbufferevent_ssl_state\fP state, int options)"
  44 .br
  45 .RI "\fICreate a new SSL bufferevent to send its data over an SSL * on a socket\&. \fP"
  46 .ti -1c
  47 .RI "int \fBbufferevent_ssl_renegotiate\fP (struct \fBbufferevent\fP *bev)"
  48 .br
  49 .RI "\fITells a bufferevent to begin SSL renegotiation\&. \fP"
  50 .in -1c
  51 .SH "Detailed Description"
  52 .PP
  53 OpenSSL support for bufferevents\&.
  54
  55
  56 .SH "Function Documentation"
  57 .PP
  58 .SS "unsigned long bufferevent_get_openssl_error (struct \fBbufferevent\fP *bev)"
  59
  60 .PP
  61 Return the most recent OpenSSL error reported on an SSL bufferevent\&.
  62 .SS "struct \fBbufferevent\fP* bufferevent_openssl_filter_new (struct \fBevent_base\fP *base, struct \fBbufferevent\fP *underlying, struct ssl_st *ssl, enum \fBbufferevent_ssl_state\fPstate, intoptions)"
  63
  64 .PP
  65 Create a new SSL bufferevent to send its data over another bufferevent\&.
  66 .PP
  67 \fBParameters:\fP
  68 .RS 4
  69 \fIbase\fP An \fBevent_base\fP to use to detect reading and writing\&. It must also be the base for the underlying bufferevent\&.
  70 .br
  71 \fIunderlying\fP A socket to use for this SSL
  72 .br
  73 \fIssl\fP A SSL* object from openssl\&.
  74 .br
  75 \fIstate\fP The current state of the SSL connection
  76 .br
  77 \fIoptions\fP One or more bufferevent_options
  78 .RE
  79 .PP
  80 \fBReturns:\fP
  81 .RS 4
  82 A new bufferevent on success, or NULL on failure
  83 .RE
  84 .PP
  85
  86 .SS "struct ssl_st* bufferevent_openssl_get_ssl (struct \fBbufferevent\fP *bufev)"
  87
  88 .PP
  89 Return the underlying openssl SSL * object for an SSL bufferevent\&.
  90 .SS "struct \fBbufferevent\fP* bufferevent_openssl_socket_new (struct \fBevent_base\fP *base, \fBevutil_socket_t\fPfd, struct ssl_st *ssl, enum \fBbufferevent_ssl_state\fPstate, intoptions)"
  91
  92 .PP
  93 Create a new SSL bufferevent to send its data over an SSL * on a socket\&.
  94 .PP
  95 \fBParameters:\fP
  96 .RS 4
  97 \fIbase\fP An \fBevent_base\fP to use to detect reading and writing
  98 .br
  99 \fIfd\fP A socket to use for this SSL
 100 .br
 101 \fIssl\fP A SSL* object from openssl\&.
 102 .br
 103 \fIstate\fP The current state of the SSL connection
 104 .br
 105 \fIoptions\fP One or more bufferevent_options
 106 .RE
 107 .PP
 108 \fBReturns:\fP
 109 .RS 4
 110 A new bufferevent on success, or NULL on failure\&.
 111 .RE
 112 .PP
 113
 114 .SS "int bufferevent_ssl_renegotiate (struct \fBbufferevent\fP *bev)"
 115
 116 .PP
 117 Tells a bufferevent to begin SSL renegotiation\&.
 118 .SH "Author"
 119 .PP
 120 Generated automatically by Doxygen for libevent from the source code\&.