-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathbufferevent__ssl_8h.html
570 lines (537 loc) · 37.5 KB
/
bufferevent__ssl_8h.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libevent: event2/bufferevent_ssl.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libevent
 <span id="projectnumber">2.2.1</span>
</div>
<div id="projectbrief">Event notification library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_db160b4728e6067cf5f9cc14ec42c79d.html">event2</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">bufferevent_ssl.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>OpenSSL support for bufferevents.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include <event2/visibility.h></code><br />
<code>#include <event2/event-config.h></code><br />
<code>#include <<a class="el" href="bufferevent_8h_source.html">event2/bufferevent.h</a>></code><br />
<code>#include <<a class="el" href="util_8h_source.html">event2/util.h</a>></code><br />
</div>
<p><a href="bufferevent__ssl_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a34aeb5156538c8ca7f5353a77aa9059b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="bufferevent__ssl_8h.html#a34aeb5156538c8ca7f5353a77aa9059b">BUFFEREVENT_SSL_BATCH_WRITE</a>   2</td></tr>
<tr class="memdesc:a34aeb5156538c8ca7f5353a77aa9059b"><td class="mdescLeft"> </td><td class="mdescRight">Control writes in the SSL bufferevents. <a href="bufferevent__ssl_8h.html#a34aeb5156538c8ca7f5353a77aa9059b">More...</a><br /></td></tr>
<tr class="separator:a34aeb5156538c8ca7f5353a77aa9059b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af65fd99ef2fa0bc7df9622dc84dfa38b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="bufferevent__ssl_8h.html#af65fd99ef2fa0bc7df9622dc84dfa38b">BUFFEREVENT_SSL_DIRTY_SHUTDOWN</a>   1</td></tr>
<tr class="memdesc:af65fd99ef2fa0bc7df9622dc84dfa38b"><td class="mdescLeft"> </td><td class="mdescRight">Control how to report dirty SSL shutdowns. <a href="bufferevent__ssl_8h.html#af65fd99ef2fa0bc7df9622dc84dfa38b">More...</a><br /></td></tr>
<tr class="separator:af65fd99ef2fa0bc7df9622dc84dfa38b"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a097540be2e2649453d1690e528f43579"><td class="memItemLeft" align="right" valign="top"><a id="a097540be2e2649453d1690e528f43579"></a>
typedef struct mbedtls_ssl_context </td><td class="memItemRight" valign="bottom"><b>mbedtls_dyncontext</b></td></tr>
<tr class="separator:a097540be2e2649453d1690e528f43579"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a96964ed61294aff8a9d95d661f403ee4"><td class="memItemLeft" align="right" valign="top"><a id="a96964ed61294aff8a9d95d661f403ee4"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="bufferevent__ssl_8h.html#a96964ed61294aff8a9d95d661f403ee4">bufferevent_ssl_state</a> { <b>BUFFEREVENT_SSL_OPEN</b> = 0,
<b>BUFFEREVENT_SSL_CONNECTING</b> = 1,
<b>BUFFEREVENT_SSL_ACCEPTING</b> = 2
}</td></tr>
<tr class="memdesc:a96964ed61294aff8a9d95d661f403ee4"><td class="mdescLeft"> </td><td class="mdescRight">The state of an SSL object to be used when creating a new SSL bufferevent. <br /></td></tr>
<tr class="separator:a96964ed61294aff8a9d95d661f403ee4"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a9ff8a04e47b127f185911ea153cde862"><td class="memItemLeft" align="right" valign="top"><a id="a9ff8a04e47b127f185911ea153cde862"></a>
EVENT2_EXPORT_SYMBOL unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="bufferevent__ssl_8h.html#a9ff8a04e47b127f185911ea153cde862">bufferevent_get_mbedtls_error</a> (struct <a class="el" href="structbufferevent.html">bufferevent</a> *bev)</td></tr>
<tr class="memdesc:a9ff8a04e47b127f185911ea153cde862"><td class="mdescLeft"> </td><td class="mdescRight">Return the most recent MbedTLS error reported on an SSL bufferevent. <br /></td></tr>
<tr class="separator:a9ff8a04e47b127f185911ea153cde862"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a02d39dd2ed160e7564f62cf487bd0315"><td class="memItemLeft" align="right" valign="top"><a id="a02d39dd2ed160e7564f62cf487bd0315"></a>
EVENT2_EXPORT_SYMBOL unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="bufferevent__ssl_8h.html#a02d39dd2ed160e7564f62cf487bd0315">bufferevent_get_openssl_error</a> (struct <a class="el" href="structbufferevent.html">bufferevent</a> *bev)</td></tr>
<tr class="memdesc:a02d39dd2ed160e7564f62cf487bd0315"><td class="mdescLeft"> </td><td class="mdescRight">Return the most recent OpenSSL error reported on an SSL bufferevent. <br /></td></tr>
<tr class="separator:a02d39dd2ed160e7564f62cf487bd0315"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:addce4bbddd3fe09b50f9042bd7d1435e"><td class="memItemLeft" align="right" valign="top"><a id="addce4bbddd3fe09b50f9042bd7d1435e"></a>
EVENT2_EXPORT_SYMBOL void </td><td class="memItemRight" valign="bottom"><a class="el" href="bufferevent__ssl_8h.html#addce4bbddd3fe09b50f9042bd7d1435e">bufferevent_mbedtls_dyncontext_free</a> (mbedtls_dyncontext *ctx)</td></tr>
<tr class="memdesc:addce4bbddd3fe09b50f9042bd7d1435e"><td class="mdescLeft"> </td><td class="mdescRight">Deallocate heap-based MbedTLS context. <br /></td></tr>
<tr class="separator:addce4bbddd3fe09b50f9042bd7d1435e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a15ef9128f6f03c98d24032d74de6f0a8"><td class="memItemLeft" align="right" valign="top"><a id="a15ef9128f6f03c98d24032d74de6f0a8"></a>
EVENT2_EXPORT_SYMBOL mbedtls_dyncontext * </td><td class="memItemRight" valign="bottom"><a class="el" href="bufferevent__ssl_8h.html#a15ef9128f6f03c98d24032d74de6f0a8">bufferevent_mbedtls_dyncontext_new</a> (struct mbedtls_ssl_config *conf)</td></tr>
<tr class="memdesc:a15ef9128f6f03c98d24032d74de6f0a8"><td class="mdescLeft"> </td><td class="mdescRight">Create a new heap-based MbedTLS context for use it in bufferevent_mbedtls_* functions. <br /></td></tr>
<tr class="separator:a15ef9128f6f03c98d24032d74de6f0a8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab70b27645fdd5a2f0294d53aa1743061"><td class="memItemLeft" align="right" valign="top">EVENT2_EXPORT_SYMBOL struct <a class="el" href="structbufferevent.html">bufferevent</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="bufferevent__ssl_8h.html#ab70b27645fdd5a2f0294d53aa1743061">bufferevent_mbedtls_filter_new</a> (struct <a class="el" href="structevent__base.html">event_base</a> *base, struct <a class="el" href="structbufferevent.html">bufferevent</a> *underlying, mbedtls_dyncontext *ssl, enum <a class="el" href="bufferevent__ssl_8h.html#a96964ed61294aff8a9d95d661f403ee4">bufferevent_ssl_state</a> state, int options)</td></tr>
<tr class="memdesc:ab70b27645fdd5a2f0294d53aa1743061"><td class="mdescLeft"> </td><td class="mdescRight">Create a new SSL bufferevent to send its data over another bufferevent. <a href="bufferevent__ssl_8h.html#ab70b27645fdd5a2f0294d53aa1743061">More...</a><br /></td></tr>
<tr class="separator:ab70b27645fdd5a2f0294d53aa1743061"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f8cc4d8ca0fc0c882659b0e7793e886"><td class="memItemLeft" align="right" valign="top">EVENT2_EXPORT_SYMBOL int </td><td class="memItemRight" valign="bottom"><a class="el" href="bufferevent__ssl_8h.html#a4f8cc4d8ca0fc0c882659b0e7793e886">bufferevent_mbedtls_get_allow_dirty_shutdown</a> (struct <a class="el" href="structbufferevent.html">bufferevent</a> *bev)</td></tr>
<tr class="memdesc:a4f8cc4d8ca0fc0c882659b0e7793e886"><td class="mdescLeft"> </td><td class="mdescRight">Get value of the BUFFEREVENT_SSL_DIRTY_SHUTDOWN flag. <a href="bufferevent__ssl_8h.html#a4f8cc4d8ca0fc0c882659b0e7793e886">More...</a><br /></td></tr>
<tr class="separator:a4f8cc4d8ca0fc0c882659b0e7793e886"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afd907d76bb66d40b6633f611c0f01526"><td class="memItemLeft" align="right" valign="top"><a id="afd907d76bb66d40b6633f611c0f01526"></a>
EVENT2_EXPORT_SYMBOL struct mbedtls_ssl_context * </td><td class="memItemRight" valign="bottom"><a class="el" href="bufferevent__ssl_8h.html#afd907d76bb66d40b6633f611c0f01526">bufferevent_mbedtls_get_ssl</a> (struct <a class="el" href="structbufferevent.html">bufferevent</a> *bufev)</td></tr>
<tr class="memdesc:afd907d76bb66d40b6633f611c0f01526"><td class="mdescLeft"> </td><td class="mdescRight">Return the underlying mbedtls SSL * object for an SSL bufferevent. <br /></td></tr>
<tr class="separator:afd907d76bb66d40b6633f611c0f01526"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad8a0aa57628113bd4fae0ad7dc796b34"><td class="memItemLeft" align="right" valign="top"><a id="ad8a0aa57628113bd4fae0ad7dc796b34"></a>
EVENT2_EXPORT_SYMBOL int </td><td class="memItemRight" valign="bottom"><a class="el" href="bufferevent__ssl_8h.html#ad8a0aa57628113bd4fae0ad7dc796b34">bufferevent_mbedtls_renegotiate</a> (struct <a class="el" href="structbufferevent.html">bufferevent</a> *bev)</td></tr>
<tr class="memdesc:ad8a0aa57628113bd4fae0ad7dc796b34"><td class="mdescLeft"> </td><td class="mdescRight">Tells a bufferevent to begin SSL renegotiation. <br /></td></tr>
<tr class="separator:ad8a0aa57628113bd4fae0ad7dc796b34"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a72794ad409cf280240988a104cc3a836"><td class="memItemLeft" align="right" valign="top">EVENT2_EXPORT_SYMBOL void </td><td class="memItemRight" valign="bottom"><a class="el" href="bufferevent__ssl_8h.html#a72794ad409cf280240988a104cc3a836">bufferevent_mbedtls_set_allow_dirty_shutdown</a> (struct <a class="el" href="structbufferevent.html">bufferevent</a> *bev, int allow_dirty_shutdown)</td></tr>
<tr class="memdesc:a72794ad409cf280240988a104cc3a836"><td class="mdescLeft"> </td><td class="mdescRight">Set value of the BUFFEREVENT_SSL_DIRTY_SHUTDOWN flag. <a href="bufferevent__ssl_8h.html#a72794ad409cf280240988a104cc3a836">More...</a><br /></td></tr>
<tr class="separator:a72794ad409cf280240988a104cc3a836"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a941a2172b791789ef1791f2c3b28be75"><td class="memItemLeft" align="right" valign="top">EVENT2_EXPORT_SYMBOL struct <a class="el" href="structbufferevent.html">bufferevent</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="bufferevent__ssl_8h.html#a941a2172b791789ef1791f2c3b28be75">bufferevent_mbedtls_socket_new</a> (struct <a class="el" href="structevent__base.html">event_base</a> *base, <a class="el" href="util_8h.html#a7ef0023565082a65020f6e56be59fd0b">evutil_socket_t</a> fd, mbedtls_dyncontext *ssl, enum <a class="el" href="bufferevent__ssl_8h.html#a96964ed61294aff8a9d95d661f403ee4">bufferevent_ssl_state</a> state, int options)</td></tr>
<tr class="memdesc:a941a2172b791789ef1791f2c3b28be75"><td class="mdescLeft"> </td><td class="mdescRight">Create a new SSL bufferevent to send its data over an SSL * on a socket. <a href="bufferevent__ssl_8h.html#a941a2172b791789ef1791f2c3b28be75">More...</a><br /></td></tr>
<tr class="separator:a941a2172b791789ef1791f2c3b28be75"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac6d45c0c7988f83b0feb2b67497e33c9"><td class="memItemLeft" align="right" valign="top">EVENT2_EXPORT_SYMBOL struct <a class="el" href="structbufferevent.html">bufferevent</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="bufferevent__ssl_8h.html#ac6d45c0c7988f83b0feb2b67497e33c9">bufferevent_openssl_filter_new</a> (struct <a class="el" href="structevent__base.html">event_base</a> *base, struct <a class="el" href="structbufferevent.html">bufferevent</a> *underlying, struct ssl_st *ssl, enum <a class="el" href="bufferevent__ssl_8h.html#a96964ed61294aff8a9d95d661f403ee4">bufferevent_ssl_state</a> state, int options)</td></tr>
<tr class="memdesc:ac6d45c0c7988f83b0feb2b67497e33c9"><td class="mdescLeft"> </td><td class="mdescRight">Create a new SSL bufferevent to send its data over another bufferevent. <a href="bufferevent__ssl_8h.html#ac6d45c0c7988f83b0feb2b67497e33c9">More...</a><br /></td></tr>
<tr class="separator:ac6d45c0c7988f83b0feb2b67497e33c9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab99fa44e01e56fbd4de25022be3ffbe4"><td class="memItemLeft" align="right" valign="top">EVENT2_EXPORT_SYMBOL int </td><td class="memItemRight" valign="bottom"><a class="el" href="bufferevent__ssl_8h.html#ab99fa44e01e56fbd4de25022be3ffbe4">bufferevent_openssl_get_allow_dirty_shutdown</a> (struct <a class="el" href="structbufferevent.html">bufferevent</a> *bev)</td></tr>
<tr class="memdesc:ab99fa44e01e56fbd4de25022be3ffbe4"><td class="mdescLeft"> </td><td class="mdescRight">Get value of the BUFFEREVENT_SSL_DIRTY_SHUTDOWN flag. <a href="bufferevent__ssl_8h.html#ab99fa44e01e56fbd4de25022be3ffbe4">More...</a><br /></td></tr>
<tr class="separator:ab99fa44e01e56fbd4de25022be3ffbe4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8e0f365c4daa5129c0cd311a3ee0149f"><td class="memItemLeft" align="right" valign="top"><a id="a8e0f365c4daa5129c0cd311a3ee0149f"></a>
EVENT2_EXPORT_SYMBOL struct ssl_st * </td><td class="memItemRight" valign="bottom"><a class="el" href="bufferevent__ssl_8h.html#a8e0f365c4daa5129c0cd311a3ee0149f">bufferevent_openssl_get_ssl</a> (struct <a class="el" href="structbufferevent.html">bufferevent</a> *bufev)</td></tr>
<tr class="memdesc:a8e0f365c4daa5129c0cd311a3ee0149f"><td class="mdescLeft"> </td><td class="mdescRight">Return the underlying openssl SSL * object for an SSL bufferevent. <br /></td></tr>
<tr class="separator:a8e0f365c4daa5129c0cd311a3ee0149f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa12d88e848c0b8b43e2e7c60992ab870"><td class="memItemLeft" align="right" valign="top">EVENT2_EXPORT_SYMBOL void </td><td class="memItemRight" valign="bottom"><a class="el" href="bufferevent__ssl_8h.html#aa12d88e848c0b8b43e2e7c60992ab870">bufferevent_openssl_set_allow_dirty_shutdown</a> (struct <a class="el" href="structbufferevent.html">bufferevent</a> *bev, int allow_dirty_shutdown)</td></tr>
<tr class="memdesc:aa12d88e848c0b8b43e2e7c60992ab870"><td class="mdescLeft"> </td><td class="mdescRight">Set value of the BUFFEREVENT_SSL_DIRTY_SHUTDOWN flag. <a href="bufferevent__ssl_8h.html#aa12d88e848c0b8b43e2e7c60992ab870">More...</a><br /></td></tr>
<tr class="separator:aa12d88e848c0b8b43e2e7c60992ab870"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7a3090b586bfc7fc02e81a3a2c2deea5"><td class="memItemLeft" align="right" valign="top">EVENT2_EXPORT_SYMBOL struct <a class="el" href="structbufferevent.html">bufferevent</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="bufferevent__ssl_8h.html#a7a3090b586bfc7fc02e81a3a2c2deea5">bufferevent_openssl_socket_new</a> (struct <a class="el" href="structevent__base.html">event_base</a> *base, <a class="el" href="util_8h.html#a7ef0023565082a65020f6e56be59fd0b">evutil_socket_t</a> fd, struct ssl_st *ssl, enum <a class="el" href="bufferevent__ssl_8h.html#a96964ed61294aff8a9d95d661f403ee4">bufferevent_ssl_state</a> state, int options)</td></tr>
<tr class="memdesc:a7a3090b586bfc7fc02e81a3a2c2deea5"><td class="mdescLeft"> </td><td class="mdescRight">Create a new SSL bufferevent to send its data over an SSL * on a socket. <a href="bufferevent__ssl_8h.html#a7a3090b586bfc7fc02e81a3a2c2deea5">More...</a><br /></td></tr>
<tr class="separator:a7a3090b586bfc7fc02e81a3a2c2deea5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3fd911cdaeaa3974bb4c17ad13f48503"><td class="memItemLeft" align="right" valign="top"><a id="a3fd911cdaeaa3974bb4c17ad13f48503"></a>
EVENT2_EXPORT_SYMBOL int </td><td class="memItemRight" valign="bottom"><a class="el" href="bufferevent__ssl_8h.html#a3fd911cdaeaa3974bb4c17ad13f48503">bufferevent_ssl_renegotiate</a> (struct <a class="el" href="structbufferevent.html">bufferevent</a> *bev)</td></tr>
<tr class="memdesc:a3fd911cdaeaa3974bb4c17ad13f48503"><td class="mdescLeft"> </td><td class="mdescRight">Tells a bufferevent to begin SSL renegotiation. <br /></td></tr>
<tr class="separator:a3fd911cdaeaa3974bb4c17ad13f48503"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>OpenSSL support for bufferevents. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a34aeb5156538c8ca7f5353a77aa9059b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a34aeb5156538c8ca7f5353a77aa9059b">◆ </a></span>BUFFEREVENT_SSL_BATCH_WRITE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BUFFEREVENT_SSL_BATCH_WRITE   2</td>
</tr>
</table>
</div><div class="memdoc">
<p>Control writes in the SSL bufferevents. </p>
<p>By default SSL bufferevent will peek bytes from the buffer as the arrived. with respect to the segment boundaries in the buffer. However, by ignoring these segment boundaries number of packets to send can be decreased.</p>
<p>This flags will ignore the segment boundaries.</p>
<p>Useful in conjunction with http layer. </p>
</div>
</div>
<a id="af65fd99ef2fa0bc7df9622dc84dfa38b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af65fd99ef2fa0bc7df9622dc84dfa38b">◆ </a></span>BUFFEREVENT_SSL_DIRTY_SHUTDOWN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BUFFEREVENT_SSL_DIRTY_SHUTDOWN   1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Control how to report dirty SSL shutdowns. </p>
<p>If the peer (or the network, or an attacker) closes the TCP connection before closing the SSL channel, and the protocol is SSL >= v3, this is a "dirty" shutdown. If BUFFEREVENT_SSL_DIRTY_SHUTDOWN is not set (default), this is reported as BEV_EVENT_ERROR.</p>
<p>If instead BUFFEREVENT_SSL_DIRTY_SHUTDOWN is set, a dirty shutdown is reported as BEV_EVENT_EOF.</p>
<p>(Note that if the protocol is < SSLv3, you will always receive BEV_EVENT_EOF, since SSL 2 and earlier cannot distinguish a secure connection close from a dirty one. This is one reason (among many) not to use SSL 2.) </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ab70b27645fdd5a2f0294d53aa1743061"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab70b27645fdd5a2f0294d53aa1743061">◆ </a></span>bufferevent_mbedtls_filter_new()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EVENT2_EXPORT_SYMBOL struct <a class="el" href="structbufferevent.html">bufferevent</a>* bufferevent_mbedtls_filter_new </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structevent__base.html">event_base</a> * </td>
<td class="paramname"><em>base</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structbufferevent.html">bufferevent</a> * </td>
<td class="paramname"><em>underlying</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">mbedtls_dyncontext * </td>
<td class="paramname"><em>ssl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">enum <a class="el" href="bufferevent__ssl_8h.html#a96964ed61294aff8a9d95d661f403ee4">bufferevent_ssl_state</a> </td>
<td class="paramname"><em>state</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>options</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new SSL bufferevent to send its data over another bufferevent. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">base</td><td>An <a class="el" href="structevent__base.html" title="Structure to hold information and state for a Libevent dispatch loop.">event_base</a> to use to detect reading and writing. It must also be the base for the underlying bufferevent. </td></tr>
<tr><td class="paramname">underlying</td><td>A socket to use for this SSL </td></tr>
<tr><td class="paramname">ssl</td><td>A SSL* object from openssl. </td></tr>
<tr><td class="paramname">state</td><td>The current state of the SSL connection </td></tr>
<tr><td class="paramname">options</td><td>One or more bufferevent_options </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A new bufferevent on success, or NULL on failure </dd></dl>
</div>
</div>
<a id="a4f8cc4d8ca0fc0c882659b0e7793e886"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f8cc4d8ca0fc0c882659b0e7793e886">◆ </a></span>bufferevent_mbedtls_get_allow_dirty_shutdown()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EVENT2_EXPORT_SYMBOL int bufferevent_mbedtls_get_allow_dirty_shutdown </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structbufferevent.html">bufferevent</a> * </td>
<td class="paramname"><em>bev</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get value of the BUFFEREVENT_SSL_DIRTY_SHUTDOWN flag. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="bufferevent__ssl_8h.html#af65fd99ef2fa0bc7df9622dc84dfa38b" title="Control how to report dirty SSL shutdowns.">BUFFEREVENT_SSL_DIRTY_SHUTDOWN</a> </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000007">Deprecated:</a></b></dt><dd>This function is deprecated, use bufferevent_ssl_get_flags() instead. </dd></dl>
<dl class="section see"><dt>See also</dt><dd>bufferevent_ssl_get_flags() </dd></dl>
</div>
</div>
<a id="a72794ad409cf280240988a104cc3a836"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72794ad409cf280240988a104cc3a836">◆ </a></span>bufferevent_mbedtls_set_allow_dirty_shutdown()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EVENT2_EXPORT_SYMBOL void bufferevent_mbedtls_set_allow_dirty_shutdown </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structbufferevent.html">bufferevent</a> * </td>
<td class="paramname"><em>bev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>allow_dirty_shutdown</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set value of the BUFFEREVENT_SSL_DIRTY_SHUTDOWN flag. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="bufferevent__ssl_8h.html#af65fd99ef2fa0bc7df9622dc84dfa38b" title="Control how to report dirty SSL shutdowns.">BUFFEREVENT_SSL_DIRTY_SHUTDOWN</a> </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000008">Deprecated:</a></b></dt><dd>This function is deprecated, use bufferevent_ssl_set_flags() instead. </dd></dl>
<dl class="section see"><dt>See also</dt><dd>bufferevent_ssl_set_flags() </dd></dl>
</div>
</div>
<a id="a941a2172b791789ef1791f2c3b28be75"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a941a2172b791789ef1791f2c3b28be75">◆ </a></span>bufferevent_mbedtls_socket_new()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EVENT2_EXPORT_SYMBOL struct <a class="el" href="structbufferevent.html">bufferevent</a>* bufferevent_mbedtls_socket_new </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structevent__base.html">event_base</a> * </td>
<td class="paramname"><em>base</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="util_8h.html#a7ef0023565082a65020f6e56be59fd0b">evutil_socket_t</a> </td>
<td class="paramname"><em>fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">mbedtls_dyncontext * </td>
<td class="paramname"><em>ssl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">enum <a class="el" href="bufferevent__ssl_8h.html#a96964ed61294aff8a9d95d661f403ee4">bufferevent_ssl_state</a> </td>
<td class="paramname"><em>state</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>options</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new SSL bufferevent to send its data over an SSL * on a socket. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">base</td><td>An <a class="el" href="structevent__base.html" title="Structure to hold information and state for a Libevent dispatch loop.">event_base</a> to use to detect reading and writing </td></tr>
<tr><td class="paramname">fd</td><td>A socket to use for this SSL </td></tr>
<tr><td class="paramname">ssl</td><td>A SSL* object from mbedtls. </td></tr>
<tr><td class="paramname">state</td><td>The current state of the SSL connection </td></tr>
<tr><td class="paramname">options</td><td>One or more bufferevent_options </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A new bufferevent on success, or NULL on failure. </dd></dl>
</div>
</div>
<a id="ac6d45c0c7988f83b0feb2b67497e33c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac6d45c0c7988f83b0feb2b67497e33c9">◆ </a></span>bufferevent_openssl_filter_new()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EVENT2_EXPORT_SYMBOL struct <a class="el" href="structbufferevent.html">bufferevent</a>* bufferevent_openssl_filter_new </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structevent__base.html">event_base</a> * </td>
<td class="paramname"><em>base</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structbufferevent.html">bufferevent</a> * </td>
<td class="paramname"><em>underlying</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct ssl_st * </td>
<td class="paramname"><em>ssl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">enum <a class="el" href="bufferevent__ssl_8h.html#a96964ed61294aff8a9d95d661f403ee4">bufferevent_ssl_state</a> </td>
<td class="paramname"><em>state</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>options</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new SSL bufferevent to send its data over another bufferevent. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">base</td><td>An <a class="el" href="structevent__base.html" title="Structure to hold information and state for a Libevent dispatch loop.">event_base</a> to use to detect reading and writing. It must also be the base for the underlying bufferevent. </td></tr>
<tr><td class="paramname">underlying</td><td>A socket to use for this SSL </td></tr>
<tr><td class="paramname">ssl</td><td>A SSL* object from openssl. </td></tr>
<tr><td class="paramname">state</td><td>The current state of the SSL connection </td></tr>
<tr><td class="paramname">options</td><td>One or more bufferevent_options </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A new bufferevent on success, or NULL on failure </dd></dl>
</div>
</div>
<a id="ab99fa44e01e56fbd4de25022be3ffbe4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab99fa44e01e56fbd4de25022be3ffbe4">◆ </a></span>bufferevent_openssl_get_allow_dirty_shutdown()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EVENT2_EXPORT_SYMBOL int bufferevent_openssl_get_allow_dirty_shutdown </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structbufferevent.html">bufferevent</a> * </td>
<td class="paramname"><em>bev</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get value of the BUFFEREVENT_SSL_DIRTY_SHUTDOWN flag. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="bufferevent__ssl_8h.html#af65fd99ef2fa0bc7df9622dc84dfa38b" title="Control how to report dirty SSL shutdowns.">BUFFEREVENT_SSL_DIRTY_SHUTDOWN</a> </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000005">Deprecated:</a></b></dt><dd>This function is deprecated, use bufferevent_ssl_get_flags() instead. </dd></dl>
<dl class="section see"><dt>See also</dt><dd>bufferevent_ssl_get_flags() </dd></dl>
</div>
</div>
<a id="aa12d88e848c0b8b43e2e7c60992ab870"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa12d88e848c0b8b43e2e7c60992ab870">◆ </a></span>bufferevent_openssl_set_allow_dirty_shutdown()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EVENT2_EXPORT_SYMBOL void bufferevent_openssl_set_allow_dirty_shutdown </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structbufferevent.html">bufferevent</a> * </td>
<td class="paramname"><em>bev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>allow_dirty_shutdown</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set value of the BUFFEREVENT_SSL_DIRTY_SHUTDOWN flag. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="bufferevent__ssl_8h.html#af65fd99ef2fa0bc7df9622dc84dfa38b" title="Control how to report dirty SSL shutdowns.">BUFFEREVENT_SSL_DIRTY_SHUTDOWN</a> </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000006">Deprecated:</a></b></dt><dd>This function is deprecated, use bufferevent_ssl_set_flags() instead. </dd></dl>
<dl class="section see"><dt>See also</dt><dd>bufferevent_ssl_set_flags() </dd></dl>
</div>
</div>
<a id="a7a3090b586bfc7fc02e81a3a2c2deea5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a3090b586bfc7fc02e81a3a2c2deea5">◆ </a></span>bufferevent_openssl_socket_new()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EVENT2_EXPORT_SYMBOL struct <a class="el" href="structbufferevent.html">bufferevent</a>* bufferevent_openssl_socket_new </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structevent__base.html">event_base</a> * </td>
<td class="paramname"><em>base</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="util_8h.html#a7ef0023565082a65020f6e56be59fd0b">evutil_socket_t</a> </td>
<td class="paramname"><em>fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct ssl_st * </td>
<td class="paramname"><em>ssl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">enum <a class="el" href="bufferevent__ssl_8h.html#a96964ed61294aff8a9d95d661f403ee4">bufferevent_ssl_state</a> </td>
<td class="paramname"><em>state</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>options</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new SSL bufferevent to send its data over an SSL * on a socket. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">base</td><td>An <a class="el" href="structevent__base.html" title="Structure to hold information and state for a Libevent dispatch loop.">event_base</a> to use to detect reading and writing </td></tr>
<tr><td class="paramname">fd</td><td>A socket to use for this SSL </td></tr>
<tr><td class="paramname">ssl</td><td>A SSL* object from openssl. </td></tr>
<tr><td class="paramname">state</td><td>The current state of the SSL connection </td></tr>
<tr><td class="paramname">options</td><td>One or more bufferevent_options </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A new bufferevent on success, or NULL on failure. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>