1 | // Copyright (c) 2012 by István Váradi
|
---|
2 |
|
---|
3 | // This file is part of libxplcommon, a common utility library for
|
---|
4 | // development related to X-Plane
|
---|
5 |
|
---|
6 | // Redistribution and use in source and binary forms, with or without
|
---|
7 | // modification, are permitted provided that the following conditions are met:
|
---|
8 |
|
---|
9 | // 1. Redistributions of source code must retain the above copyright notice, this
|
---|
10 | // list of conditions and the following disclaimer.
|
---|
11 | // 2. Redistributions in binary form must reproduce the above copyright notice,
|
---|
12 | // this list of conditions and the following disclaimer in the documentation
|
---|
13 | // and/or other materials provided with the distribution.
|
---|
14 |
|
---|
15 | // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
---|
16 | // ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
---|
17 | // WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
---|
18 | // DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
|
---|
19 | // ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
---|
20 | // (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
---|
21 | // LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
---|
22 | // ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
---|
23 | // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
---|
24 | // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
---|
25 |
|
---|
26 | // The views and conclusions contained in the software and documentation are those
|
---|
27 | // of the authors and should not be interpreted as representing official policies,
|
---|
28 | // either expressed or implied, of the FreeBSD Project.
|
---|
29 |
|
---|
30 | #ifndef XPLCOMMON_POSIX_CLIENTSOCKET_H
|
---|
31 | #define XPLCOMMON_POSIX_CLIENTSOCKET_H
|
---|
32 | //------------------------------------------------------------------------------
|
---|
33 |
|
---|
34 | #include "Socket.h"
|
---|
35 |
|
---|
36 | //------------------------------------------------------------------------------
|
---|
37 |
|
---|
38 | namespace xplcommon { namespace posix {
|
---|
39 |
|
---|
40 | //------------------------------------------------------------------------------
|
---|
41 |
|
---|
42 | /**
|
---|
43 | * A socket that can be connected to another one.
|
---|
44 | */
|
---|
45 | class ClientSocket : public Socket
|
---|
46 | {
|
---|
47 | private:
|
---|
48 | /**
|
---|
49 | * The connector, if any. It is created only, if requested.
|
---|
50 | */
|
---|
51 | Connector* connector;
|
---|
52 |
|
---|
53 | protected:
|
---|
54 | /**
|
---|
55 | * Construct the socket with the given parameters.
|
---|
56 | */
|
---|
57 | ClientSocket(int domain, int type, Waiter* waiter = 0, int protocol = 0,
|
---|
58 | size_t readingCapacity = DEFAULT_CAPACITY,
|
---|
59 | size_t writingCapacity = DEFAULT_CAPACITY);
|
---|
60 |
|
---|
61 | public:
|
---|
62 | /**
|
---|
63 | * Destroy the socket.
|
---|
64 | */
|
---|
65 | virtual ~ClientSocket();
|
---|
66 |
|
---|
67 | /**
|
---|
68 | * Get the connector. Use this object to connect to another socket.
|
---|
69 | */
|
---|
70 | Connector& getConnector();
|
---|
71 |
|
---|
72 | protected:
|
---|
73 | /**
|
---|
74 | * Create a new connector of the correct type.
|
---|
75 | */
|
---|
76 | virtual Connector* createConnector() = 0;
|
---|
77 |
|
---|
78 | /**
|
---|
79 | * Handle any events on the file descriptor. If a connection is in
|
---|
80 | * progress, and the incoming events have the EPOLLOUT flag set,
|
---|
81 | * the connector is called to handle the event. Then the parent
|
---|
82 | * class' handleEvents function is called.
|
---|
83 | */
|
---|
84 | virtual void handleEvents(short events);
|
---|
85 |
|
---|
86 | friend class Connector;
|
---|
87 | };
|
---|
88 |
|
---|
89 | //------------------------------------------------------------------------------
|
---|
90 | // Inline definitions
|
---|
91 | //------------------------------------------------------------------------------
|
---|
92 |
|
---|
93 | inline ClientSocket::ClientSocket(int domain, int type, Waiter* waiter,
|
---|
94 | int protocol, size_t readingCapacity,
|
---|
95 | size_t writingCapacity) :
|
---|
96 | Socket(domain, type, waiter, protocol, readingCapacity, writingCapacity),
|
---|
97 | connector(0)
|
---|
98 | {
|
---|
99 | }
|
---|
100 |
|
---|
101 | //------------------------------------------------------------------------------
|
---|
102 |
|
---|
103 | } /* namespace xplcommon::posix */ } /* namespace xplcommon */
|
---|
104 |
|
---|
105 | //------------------------------------------------------------------------------
|
---|
106 | #endif // XPLCOMMON_POSIX_CLIENTSOCKET_H
|
---|
107 |
|
---|
108 | // Local Variables:
|
---|
109 | // mode: C++
|
---|
110 | // c-basic-offset: 4
|
---|
111 | // indent-tabs-mode: nil
|
---|
112 | // End:
|
---|