Debian Codegraph @

external/boringssl/ssl/test/packeted_bio.h

raw
1 /* Copyright (c) 2014, Google Inc.
2 *
3 * Permission to use, copy, modify, and/or distribute this software for any
4 * purpose with or without fee is hereby granted, provided that the above
5 * copyright notice and this permission notice appear in all copies.
6 *
7 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
10 * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
12 * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
13 * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */
14
15 #ifndef HEADER_PACKETED_BIO
16 #define HEADER_PACKETED_BIO
17
18 #include <openssl/base.h>
19 #include <openssl/bio.h>
20
21 #include "../../crypto/test/scoped_types.h"
22
23 #if defined(OPENSSL_WINDOWS)
24 OPENSSL_MSVC_PRAGMA(warning(push, 3))
25 #include <winsock2.h>
26 OPENSSL_MSVC_PRAGMA(warning(pop))
27 #else
28 #include <sys/time.h>
29 #endif
30
31
32 // PacketedBioCreate creates a filter BIO which implements a reliable in-order
33 // blocking datagram socket. It internally maintains a clock and honors
34 // |BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT| based on it.
35 //
36 // During a |BIO_read|, the peer may signal the filter BIO to simulate a
37 // timeout. If |advance_clock| is true, it automatically advances the clock and
38 // continues reading, subject to the read deadline. Otherwise, it fails
39 // immediately. The caller must then call |PacketedBioAdvanceClock| before
40 // retrying |BIO_read|.
41 ScopedBIO PacketedBioCreate(bool advance_clock);
42
43 // PacketedBioGetClock returns the current time for |bio|.
44 timeval PacketedBioGetClock(const BIO *bio);
45
46 // PacketedBioAdvanceClock advances |bio|'s internal clock and returns true if
47 // there is a pending timeout. Otherwise, it returns false.
48 bool PacketedBioAdvanceClock(BIO *bio);
49
50
51 #endif // HEADER_PACKETED_BIO