]> git.ipfire.org Git - thirdparty/openssl.git/blame - test/ossl_shim/packeted_bio.h
Rename BoringSSL style OPENSSL_WINDOWS to OPENSSL_SYS_WINDOWS
[thirdparty/openssl.git] / test / ossl_shim / packeted_bio.h
CommitLineData
eef977aa
MC
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
7b73b7be 18#include <openssl/base.h>
eef977aa
MC
19#include <openssl/bio.h>
20
1669b7b5 21#if defined(OPENSSL_SYS_WINDOWS)
7b73b7be 22OPENSSL_MSVC_PRAGMA(warning(push, 3))
eef977aa 23#include <winsock2.h>
7b73b7be 24OPENSSL_MSVC_PRAGMA(warning(pop))
eef977aa
MC
25#else
26#include <sys/time.h>
27#endif
28
29
30// PacketedBioCreate creates a filter BIO which implements a reliable in-order
7b73b7be
MC
31// blocking datagram socket. It internally maintains a clock and honors
32// |BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT| based on it.
eef977aa 33//
7b73b7be
MC
34// During a |BIO_read|, the peer may signal the filter BIO to simulate a
35// timeout. If |advance_clock| is true, it automatically advances the clock and
36// continues reading, subject to the read deadline. Otherwise, it fails
37// immediately. The caller must then call |PacketedBioAdvanceClock| before
38// retrying |BIO_read|.
39bssl::UniquePtr<BIO> PacketedBioCreate(bool advance_clock);
40
41// PacketedBioGetClock returns the current time for |bio|.
42timeval PacketedBioGetClock(const BIO *bio);
43
44// PacketedBioAdvanceClock advances |bio|'s internal clock and returns true if
45// there is a pending timeout. Otherwise, it returns false.
46bool PacketedBioAdvanceClock(BIO *bio);
eef977aa
MC
47
48
49#endif // HEADER_PACKETED_BIO