SNode.C
Loading...
Searching...
No Matches
SocketContext.h
Go to the documentation of this file.
1/*
2 * SNode.C - A Slim Toolkit for Network Communication
3 * Copyright (C) Volker Christian <me@vchrist.at>
4 * 2020, 2021, 2022, 2023, 2024, 2025
5 *
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Lesser General Public License as published
8 * by the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20/*
21 * MIT License
22 *
23 * Permission is hereby granted, free of charge, to any person obtaining a copy
24 * of this software and associated documentation files (the "Software"), to deal
25 * in the Software without restriction, including without limitation the rights
26 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
27 * copies of the Software, and to permit persons to whom the Software is
28 * furnished to do so, subject to the following conditions:
29 *
30 * The above copyright notice and this permission notice shall be included in
31 * all copies or substantial portions of the Software.
32 *
33 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
34 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
35 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
36 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
37 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
38 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
39 * THE SOFTWARE.
40 */
41
42#ifndef CORE_SOCKET_SOCKETCONTEXT_H
43#define CORE_SOCKET_SOCKETCONTEXT_H
44
45namespace utils {
46 class Timeval;
47} // namespace utils
48
49#ifndef DOXYGEN_SHOULD_SKIP_THIS
50
51#include <cstddef>
52#include <string>
53
54#endif /* DOXYGEN_SHOULD_SKIP_THIS */
55
56namespace core::socket {
57
59 protected:
60 SocketContext() = default;
61
62 public:
63 SocketContext(const SocketContext&) = delete;
65
68
69 protected:
70 virtual ~SocketContext();
71
72 public:
73 virtual void setTimeout(const utils::Timeval& timeout) = 0;
74
75 void sendToPeer(const std::string& data) const;
76 virtual void sendToPeer(const char* chunk, std::size_t chunkLen) const = 0;
77
78 virtual std::size_t readFromPeer(char* chunk, std::size_t chunklen) const = 0;
79
80 virtual void close() = 0;
81
82 protected:
83 virtual std::size_t onReceivedFromPeer() = 0;
84
85 virtual bool onSignal(int sig) = 0;
86
87 virtual void onWriteError(int errnum) = 0;
88 virtual void onReadError(int errnum) = 0;
89 };
90
91} // namespace core::socket
92
93#endif // CORE_SOCKET_SOCKETCONTEXT_H
core::socket::stream::SocketContext * create(core::socket::stream::SocketConnection *socketConnection) override
core::socket::stream::SocketContext * create(core::socket::stream::SocketConnection *socketConnection) override
EchoSocketContext(core::socket::stream::SocketConnection *socketConnection, Role role)
void sendToPeer(const std::string &data) const
virtual void onReadError(int errnum)=0
virtual std::size_t onReceivedFromPeer()=0
virtual std::size_t readFromPeer(char *chunk, std::size_t chunklen) const =0
virtual void setTimeout(const utils::Timeval &timeout)=0
SocketContext(const SocketContext &)=delete
virtual void onWriteError(int errnum)=0
SocketContext(SocketContext &&)=delete
SocketContext & operator=(const SocketContext &)=delete
virtual void sendToPeer(const char *chunk, std::size_t chunkLen) const =0
virtual bool onSignal(int sig)=0
SocketContext & operator=(SocketContext &&)=delete
SocketConnection * getSocketConnection() const
virtual void switchSocketContext(SocketContext *newSocketContext)
SocketContext(core::socket::stream::SocketConnection *socketConnection)
std::size_t readFromPeer(char *chunk, std::size_t chunklen) const final
void onReadError(int errnum) override
void sendToPeer(const char *chunk, std::size_t chunkLen) const final
void shutdownWrite(bool forceClose=false)
void onWriteError(int errnum) override
bool streamToPeer(core::pipe::Source *source) const
core::socket::stream::SocketConnection * socketConnection
void setTimeout(const utils::Timeval &timeout) final