test/ossl_shim/async_bio.h

   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_ASYNC_BIO
  16 #define HEADER_ASYNC_BIO
  17
  18 #include <openssl/base.h>
  19 #include <openssl/bio.h>
  20
  21
  22 // AsyncBioCreate creates a filter BIO for testing asynchronous state
  23 // machines which consume a stream socket. Reads and writes will fail
  24 // and return EAGAIN unless explicitly allowed. Each async BIO has a
  25 // read quota and a write quota. Initially both are zero. As each is
  26 // incremented, bytes are allowed to flow through the BIO.
  27 bssl::UniquePtr<BIO> AsyncBioCreate();
  28
  29 // AsyncBioCreateDatagram creates a filter BIO for testing for
  30 // asynchronous state machines which consume datagram sockets. The read
  31 // and write quota count in packets rather than bytes.
  32 bssl::UniquePtr<BIO> AsyncBioCreateDatagram();
  33
  34 // AsyncBioAllowRead increments |bio|'s read quota by |count|.
  35 void AsyncBioAllowRead(BIO *bio, size_t count);
  36
  37 // AsyncBioAllowWrite increments |bio|'s write quota by |count|.
  38 void AsyncBioAllowWrite(BIO *bio, size_t count);
  39
  40 // AsyncBioEnforceWriteQuota configures where |bio| enforces its write quota.
  41 void AsyncBioEnforceWriteQuota(BIO *bio, bool enforce);
  42
  43
  44 #endif  // HEADER_ASYNC_BIO