Botan 3.5.0
Crypto and TLS for C&
socket.h
Go to the documentation of this file.
1/*
2* OS specific utility functions
3* (C) 2015,2016,2017 Jack Lloyd
4*
5* Botan is released under the Simplified BSD License (see license.txt)
6*/
7
8#ifndef BOTAN_SOCKET_H_
9#define BOTAN_SOCKET_H_
10
11#include <botan/types.h>
12#include <chrono>
13#include <string>
14
15namespace Botan::OS {
16
17/*
18* This header is internal (not installed) and these functions are not
19* intended to be called by applications. However they are given public
20* visibility (using BOTAN_TEST_API macro) for the tests. This also probably
21* allows them to be overridden by the application on ELF systems, but
22* this hasn't been tested.
23*/
24
25/**
26* A wrapper around a simple blocking TCP socket
27*/
29 public:
30 /**
31 * The socket will be closed upon destruction
32 */
33 virtual ~Socket() = default;
34
35 /**
36 * Write to the socket. Blocks until all bytes sent.
37 * Throws on error.
38 */
39 virtual void write(const uint8_t buf[], size_t len) = 0;
40
41 /**
42 * Reads up to len bytes, returns bytes written to buf.
43 * Returns 0 on EOF. Throws on error.
44 */
45 virtual size_t read(uint8_t buf[], size_t len) = 0;
46};
47
48/**
49* Open up a socket. Will throw on error. Returns null if sockets are
50* not available on this platform.
51*/
52std::unique_ptr<Socket> BOTAN_TEST_API open_socket(std::string_view hostname,
53 std::string_view service,
54 std::chrono::milliseconds timeout);
55
56} // namespace Botan::OS
57
58#endif
virtual size_t read(uint8_t buf[], size_t len)=0
virtual ~Socket()=default
virtual void write(const uint8_t buf[], size_t len)=0
#define BOTAN_TEST_API
Definition compiler.h:51
std::unique_ptr< Socket > BOTAN_TEST_API open_socket(std::string_view hostname, std::string_view service, std::chrono::milliseconds timeout)
Definition socket.cpp:351