async_bio.h 1.8 KB

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