source: vscpl/src/hu/varadiistvan/scpl/io/LocalAcceptor.h@ 32:fd970caf83eb

Last change on this file since 32:fd970caf83eb was 27:3c2f8c4beb2c, checked in by István Váradi <ivaradi@…>, 2 years ago

An acceptor interface that returns a generic BufferdStream instead of a specific socket.

File size: 4.9 KB
Line 
1// Copyright (c) 2013 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#ifndef HU_VARADIISTVAN_SCPL_IO_LOCALACCEPTOR_H
30#define HU_VARADIISTVAN_SCPL_IO_LOCALACCEPTOR_H
31//------------------------------------------------------------------------------
32
33#if 0 // The public interface of LocalAcceptor
34
35//------------------------------------------------------------------------------
36
37namespace hu { namespace varadiistvan { namespace scpl { namespace io {
38
39//------------------------------------------------------------------------------
40
41/**
42 * An acceptor that provides a LocalSocket for each accepted
43 * connection.
44 */
45class LocalAcceptor : public FailableReference<LocalAcceptor>,
46 public BufferedStreamAcceptor
47{
48public:
49
50 /**
51 * Start accepting a connection.
52 *
53 * If a connection is already accepted, but not retrieved yet, it
54 * returns true.
55 *
56 * If a new socket becomes immediately available, it returns true.
57 *
58 * If some error occurs, the acceptor is marked as failed.
59 */
60 bool accept();
61
62 /**
63 * Get the local socket accepted last. If no socket was accepted,
64 * return 0. The local socket's waiter will be the given one. If
65 * the server socket has no waiter, this one should be 0. If the
66 * server socket has a waiter, this one should not be 0. In other
67 * words, if the server socket is non-blocking, the accepted one
68 * should also be non-blocking, if the server socket is blocking,
69 * the accepted one should also be blocking.
70 */
71 LocalSocket* getSocket(Waiter* waiter,
72 size_t readingCapacity = LocalSocket::DEFAULT_CAPACITY,
73 size_t writingCapacity = LocalSocket::DEFAULT_CAPACITY);
74 /**
75 * Get the local socket accepted last. If no socket was accepted,
76 * return 0. The local socket's waiter will be the same as that of
77 * the associated server socket.
78 */
79 LocalSocket* getSocket(size_t readingCapacity = LocalSocket::DEFAULT_CAPACITY,
80 size_t writingCapacity = LocalSocket::DEFAULT_CAPACITY);
81
82 /**
83 * Get the last accepted socket with the given waiter, if any.
84 */
85 BufferedStream* getAcceptedBufferedStream(Waiter* waiter = nullptr) override;
86};
87
88//------------------------------------------------------------------------------
89
90} /* namespace hu::varadiistvan::scpl::io */ } /* namespace hu::varadiistvan::scpl */ } /* namespace hu::varadiistvan */ } /* namespace hu */
91
92//------------------------------------------------------------------------------
93
94#endif // 0, The public interface of LocalAcceptor
95
96//------------------------------------------------------------------------------
97
98#include "hu/varadiistvan/scpl/config.h"
99
100//------------------------------------------------------------------------------
101
102#if TARGET_API_POSIX
103
104#include "_posix/LocalAcceptor.h"
105
106//------------------------------------------------------------------------------
107
108#elif TARGET_API_WIN32 || TARGET_API_WIN64
109
110#include "_win32/LocalAcceptor.h"
111
112//------------------------------------------------------------------------------
113
114#else
115
116#error "Not implemented for this target!"
117
118#endif
119
120//------------------------------------------------------------------------------
121#endif // HU_VARADIISTVAN_SCPL_LOCALACCEPTOR_H
122
123// Local Variables:
124// mode: C++
125// c-basic-offset: 4
126// indent-tabs-mode: nil
127// End:
Note: See TracBrowser for help on using the repository browser.