source: vscpl/src/hu/varadiistvan/scpl/io/TCPAcceptor.h@ 34:e701500cc5a9

Last change on this file since 34:e701500cc5a9 was 34:e701500cc5a9, checked in by István Váradi <ivaradi@…>, 17 months ago

Public intefaces of classes related to TCP communication

File size: 4.7 KB
Line 
1// Copyright (c) 2022 by István Váradi
2
3// This file is part of VSCPL, a simple cross-platform utility library
4
5// Redistribution and use in source and binary forms, with or without
6// modification, are permitted provided that the following conditions are met:
7
8// 1. Redistributions of source code must retain the above copyright notice, this
9// list of conditions and the following disclaimer.
10// 2. Redistributions in binary form must reproduce the above copyright notice,
11// this list of conditions and the following disclaimer in the documentation
12// and/or other materials provided with the distribution.
13
14// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
15// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
18// ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
23// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24
25// The views and conclusions contained in the software and documentation are those
26// of the authors and should not be interpreted as representing official policies,
27// either expressed or implied, of the FreeBSD Project.
28
29#pragma once
30
31//------------------------------------------------------------------------------
32
33#if 0 // The public interface of TCPAcceptor
34
35//------------------------------------------------------------------------------
36
37namespace hu { namespace varadiistvan { namespace scpl { namespace io {
38
39//------------------------------------------------------------------------------
40
41/**
42 * An acceptor that provides a TCPSocket for each accepted
43 * connection.
44 */
45class TCPAcceptor : public FailableReference<TCPAcceptor>,
46 public BufferedStreamAcceptor
47{
48public:
49 /**
50 * Start accepting a connection.
51 *
52 * If a connection is already accepted, but not retrieved yet, it
53 * returns true.
54 *
55 * If a new socket becomes immediately available, it returns true.
56 *
57 * If some error occurs, the acceptor is marked as failed.
58 */
59 bool accept();
60
61 /**
62 * Get the TCP socket accepted last. If no socket was accepted,
63 * return 0. The TCP socket's waiter will be the given one. If
64 * the server socket has no waiter, this one should be 0. If the
65 * server socket has a waiter, this one should not be 0. In other
66 * words, if the server socket is non-blocking, the accepted one
67 * should also be non-blocking, if the server socket is blocking,
68 * the accepted one should also be blocking.
69 */
70 TCPSocket* getSocket(Waiter* waiter,
71 size_t readingCapacity = LocalSocket::DEFAULT_CAPACITY,
72 size_t writingCapacity = LocalSocket::DEFAULT_CAPACITY);
73 /**
74 * Get the TCP socket accepted last. If no socket was accepted,
75 * return 0. The TCP socket's waiter will be the same as that of
76 * the associated server socket.
77 */
78 TCPSocket* getSocket(size_t readingCapacity = LocalSocket::DEFAULT_CAPACITY,
79 size_t writingCapacity = LocalSocket::DEFAULT_CAPACITY);
80
81 /**
82 * Get the last accepted socket with the given waiter, if any.
83 */
84 BufferedStream* getAcceptedBufferedStream(Waiter* waiter = nullptr) override;
85};
86
87//------------------------------------------------------------------------------
88
89} /* namespace hu::varadiistvan::scpl::io */ } /* namespace hu::varadiistvan::scpl */ } /* namespace hu::varadiistvan */ } /* namespace hu */
90
91//------------------------------------------------------------------------------
92
93#endif // 0, The public interface of LocalAcceptor
94
95//------------------------------------------------------------------------------
96
97#include "hu/varadiistvan/scpl/config.h"
98
99//------------------------------------------------------------------------------
100
101#if TARGET_API_POSIX
102
103#include "_posix/TCPAcceptor.h"
104
105//------------------------------------------------------------------------------
106
107#elif TARGET_API_WIN32 || TARGET_API_WIN64
108
109#include "_win32/TCPAcceptor.h"
110
111//------------------------------------------------------------------------------
112
113#else
114
115#error "Not implemented for this target!"
116
117#endif
118
119//------------------------------------------------------------------------------
120
121// Local Variables:
122// mode: C++
123// c-basic-offset: 4
124// indent-tabs-mode: nil
125// End:
Note: See TracBrowser for help on using the repository browser.