2016-10-28 16:57:16 +08:00
|
|
|
/*
|
2018-02-13 20:51:29 +08:00
|
|
|
* Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
|
2016-10-10 19:17:21 +08:00
|
|
|
*
|
2016-10-28 16:57:16 +08:00
|
|
|
* Licensed under the OpenSSL license (the "License"). You may not use
|
|
|
|
* this file except in compliance with the License. You can obtain a copy
|
|
|
|
* in the file LICENSE in the source distribution or at
|
|
|
|
* https://www.openssl.org/source/license.html
|
|
|
|
*/
|
2016-10-10 19:17:21 +08:00
|
|
|
|
|
|
|
#ifndef HEADER_PACKETED_BIO
|
|
|
|
#define HEADER_PACKETED_BIO
|
|
|
|
|
2016-10-12 17:56:29 +08:00
|
|
|
#include <openssl/base.h>
|
2016-10-10 19:17:21 +08:00
|
|
|
#include <openssl/bio.h>
|
|
|
|
|
|
|
|
// PacketedBioCreate creates a filter BIO which implements a reliable in-order
|
2016-10-12 17:56:29 +08:00
|
|
|
// blocking datagram socket. It internally maintains a clock and honors
|
|
|
|
// |BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT| based on it.
|
2016-10-10 19:17:21 +08:00
|
|
|
//
|
2016-10-12 17:56:29 +08:00
|
|
|
// During a |BIO_read|, the peer may signal the filter BIO to simulate a
|
|
|
|
// timeout. If |advance_clock| is true, it automatically advances the clock and
|
|
|
|
// continues reading, subject to the read deadline. Otherwise, it fails
|
|
|
|
// immediately. The caller must then call |PacketedBioAdvanceClock| before
|
|
|
|
// retrying |BIO_read|.
|
|
|
|
bssl::UniquePtr<BIO> PacketedBioCreate(bool advance_clock);
|
|
|
|
|
|
|
|
// PacketedBioGetClock returns the current time for |bio|.
|
|
|
|
timeval PacketedBioGetClock(const BIO *bio);
|
|
|
|
|
|
|
|
// PacketedBioAdvanceClock advances |bio|'s internal clock and returns true if
|
|
|
|
// there is a pending timeout. Otherwise, it returns false.
|
|
|
|
bool PacketedBioAdvanceClock(BIO *bio);
|
2016-10-10 19:17:21 +08:00
|
|
|
|
|
|
|
|
|
|
|
#endif // HEADER_PACKETED_BIO
|