5 #ifndef BITCOIN_UTIL_SOCK_H
6 #define BITCOIN_UTIL_SOCK_H
15 #include <unordered_map>
75 [[nodiscard]]
virtual ssize_t
Send(
const void* data,
size_t len,
int flags)
const;
81 [[nodiscard]]
virtual ssize_t
Recv(
void* buf,
size_t len,
int flags)
const;
87 [[nodiscard]]
virtual int Connect(
const sockaddr* addr, socklen_t addr_len)
const;
93 [[nodiscard]]
virtual int Bind(
const sockaddr* addr, socklen_t addr_len)
const;
99 [[nodiscard]]
virtual int Listen(
int backlog)
const;
107 [[nodiscard]]
virtual std::unique_ptr<Sock>
Accept(sockaddr* addr, socklen_t* addr_len)
const;
114 [[nodiscard]]
virtual int GetSockOpt(
int level,
117 socklen_t* opt_len)
const;
124 [[nodiscard]]
virtual int SetSockOpt(
int level,
127 socklen_t opt_len)
const;
134 [[nodiscard]]
virtual int GetSockName(sockaddr*
name, socklen_t* name_len)
const;
176 [[nodiscard]]
virtual bool Wait(std::chrono::milliseconds timeout,
178 Event* occurred =
nullptr)
const;
190 size_t operator()(
const std::shared_ptr<const Sock>& s)
const
192 return s ? s->m_socket : std::numeric_limits<SOCKET>::max();
198 const std::shared_ptr<const Sock>& rhs)
const
201 return lhs->m_socket == rhs->m_socket;
228 [[nodiscard]]
virtual bool WaitMany(std::chrono::milliseconds timeout,
242 std::chrono::milliseconds timeout,
258 std::chrono::milliseconds timeout,
260 size_t max_data)
const;
267 [[nodiscard]]
virtual bool IsConnected(std::string& errmsg)
const;
RAII helper class that manages a socket.
virtual std::unique_ptr< Sock > Accept(sockaddr *addr, socklen_t *addr_len) const
accept(2) wrapper.
virtual ssize_t Send(const void *data, size_t len, int flags) const
send(2) wrapper.
static constexpr Event SEND
If passed to Wait(), then it will wait for readiness to send to the socket.
SOCKET m_socket
Contained socket.
virtual void SendComplete(const std::string &data, std::chrono::milliseconds timeout, CThreadInterrupt &interrupt) const
Send the given data, retrying on transient errors.
virtual int Bind(const sockaddr *addr, socklen_t addr_len) const
bind(2) wrapper.
virtual bool Wait(std::chrono::milliseconds timeout, Event requested, Event *occurred=nullptr) const
Wait for readiness for input (recv) or output (send).
virtual ~Sock()
Destructor, close the socket or do nothing if empty.
Sock(const Sock &)=delete
Copy constructor, disabled because closing the same socket twice is undesirable.
virtual int GetSockName(sockaddr *name, socklen_t *name_len) const
getsockname(2) wrapper.
void Close()
Close m_socket if it is not INVALID_SOCKET.
Sock()
Default constructor, creates an empty object that does nothing when destroyed.
virtual bool WaitMany(std::chrono::milliseconds timeout, EventsPerSock &events_per_sock) const
Same as Wait(), but wait on many sockets within the same timeout.
static constexpr Event ERR
Ignored if passed to Wait(), but could be set in the occurred events if an exceptional condition has ...
virtual bool IsConnected(std::string &errmsg) const
Check if still connected.
virtual int SetSockOpt(int level, int opt_name, const void *opt_val, socklen_t opt_len) const
setsockopt(2) wrapper.
static constexpr Event RECV
If passed to Wait(), then it will wait for readiness to read from the socket.
virtual SOCKET Get() const
Get the value of the contained socket.
virtual int GetSockOpt(int level, int opt_name, void *opt_val, socklen_t *opt_len) const
getsockopt(2) wrapper.
virtual int Connect(const sockaddr *addr, socklen_t addr_len) const
connect(2) wrapper.
Sock & operator=(const Sock &)=delete
Copy assignment operator, disabled because closing the same socket twice is undesirable.
virtual ssize_t Recv(void *buf, size_t len, int flags) const
recv(2) wrapper.
virtual std::string RecvUntilTerminator(uint8_t terminator, std::chrono::milliseconds timeout, CThreadInterrupt &interrupt, size_t max_data) const
Read from socket until a terminator character is encountered.
virtual int Listen(int backlog) const
listen(2) wrapper.
virtual bool SetNonBlocking() const
Set the non-blocking option on the socket.
std::unordered_map< std::shared_ptr< const Sock >, Events, HashSharedPtrSock, EqualSharedPtrSock > EventsPerSock
On which socket to wait for what events in WaitMany().
virtual bool IsSelectable() const
Check if the underlying socket can be used for select(2) (or the Wait() method).
static constexpr auto MAX_WAIT_FOR_IO
Maximum time to wait for I/O readiness.
std::string NetworkErrorString(int err)
Return readable error string for a network error code.
bool operator()(const std::shared_ptr< const Sock > &lhs, const std::shared_ptr< const Sock > &rhs) const
Auxiliary requested/occurred events to wait for in WaitMany().
size_t operator()(const std::shared_ptr< const Sock > &s) const