[8] | 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_POSIX_CONNECTOR_H
|
---|
| 30 | #define HU_VARADIISTVAN_SCPL_IO_POSIX_CONNECTOR_H
|
---|
| 31 | //------------------------------------------------------------------------------
|
---|
| 32 |
|
---|
| 33 | #include "../Failable.h"
|
---|
| 34 |
|
---|
| 35 | #include "ClientSocket.h"
|
---|
| 36 |
|
---|
| 37 | #include <cstdlib>
|
---|
| 38 |
|
---|
| 39 | //------------------------------------------------------------------------------
|
---|
| 40 |
|
---|
| 41 | struct sockaddr;
|
---|
| 42 |
|
---|
| 43 | //------------------------------------------------------------------------------
|
---|
| 44 |
|
---|
| 45 | namespace hu { namespace varadiistvan { namespace scpl { namespace io {
|
---|
| 46 |
|
---|
| 47 | //------------------------------------------------------------------------------
|
---|
| 48 |
|
---|
| 49 | /**
|
---|
| 50 | * Class representing the creation of a connection to some remote
|
---|
| 51 | * entity, like a socket or a pipe.
|
---|
| 52 | */
|
---|
| 53 | class Connector : public FailableReference<Connector>
|
---|
| 54 | {
|
---|
| 55 | private:
|
---|
| 56 | /**
|
---|
| 57 | * The socket on behalf of which the connection is being
|
---|
| 58 | * performed.
|
---|
| 59 | */
|
---|
| 60 | ClientSocket& socket;
|
---|
| 61 |
|
---|
| 62 | /**
|
---|
| 63 | * Indicate that we are in the process of connecting.
|
---|
| 64 | */
|
---|
| 65 | bool connecting;
|
---|
| 66 |
|
---|
| 67 | /**
|
---|
| 68 | * Indicate that we are connected.
|
---|
| 69 | */
|
---|
| 70 | bool connected;
|
---|
| 71 |
|
---|
| 72 | protected:
|
---|
| 73 | /**
|
---|
| 74 | * Construct the connector.
|
---|
| 75 | */
|
---|
| 76 | Connector(ClientSocket* socket);
|
---|
| 77 |
|
---|
| 78 | public:
|
---|
| 79 | /**
|
---|
| 80 | * Connect to an address properly set up.
|
---|
| 81 | *
|
---|
| 82 | * If the connection succeeds immediately, it indicates success.
|
---|
| 83 | *
|
---|
| 84 | * If the connection does not succeed, because it would block, it
|
---|
| 85 | * sets up the socket to wait for the connection to succeed, and
|
---|
| 86 | * returns failure.
|
---|
| 87 | *
|
---|
| 88 | * If the connection fails for another reason, the error code is
|
---|
| 89 | * set, and false is returned.
|
---|
| 90 | */
|
---|
| 91 | bool connect();
|
---|
| 92 |
|
---|
| 93 | protected:
|
---|
| 94 | /**
|
---|
| 95 | * Get the parameters for connecting.
|
---|
| 96 | */
|
---|
| 97 | virtual const struct sockaddr* getAddress(size_t& addrlen) = 0;
|
---|
| 98 |
|
---|
| 99 | /**
|
---|
| 100 | * Handle the event that the socket is writable.
|
---|
| 101 | *
|
---|
| 102 | * If connection is in progress, this function returns
|
---|
| 103 | * immediately.
|
---|
| 104 | *
|
---|
| 105 | * Otherwise it reads the error code using getsockopt(), and if it
|
---|
| 106 | * indicates success, the connector is set to connected, otherwise
|
---|
| 107 | * it is set to failed.
|
---|
| 108 | */
|
---|
| 109 | void handleWritable();
|
---|
| 110 |
|
---|
| 111 | private:
|
---|
| 112 | /**
|
---|
| 113 | * Get the failable object.
|
---|
| 114 | */
|
---|
| 115 | const Failable& getFailable() const;
|
---|
| 116 |
|
---|
| 117 | /**
|
---|
| 118 | * Get the failable object.
|
---|
| 119 | */
|
---|
| 120 | Failable& getFailable();
|
---|
| 121 |
|
---|
| 122 | friend class FailableReference<Connector>;
|
---|
| 123 | friend class ClientSocket;
|
---|
| 124 | };
|
---|
| 125 |
|
---|
| 126 | //------------------------------------------------------------------------------
|
---|
| 127 | // Inline definitions
|
---|
| 128 | //------------------------------------------------------------------------------
|
---|
| 129 |
|
---|
| 130 | inline Connector::Connector(ClientSocket* socket) :
|
---|
| 131 | socket(*socket),
|
---|
| 132 | connecting(false),
|
---|
| 133 | connected(false)
|
---|
| 134 | {
|
---|
| 135 | }
|
---|
| 136 |
|
---|
| 137 | //------------------------------------------------------------------------------
|
---|
| 138 |
|
---|
| 139 | inline const Failable& Connector::getFailable() const
|
---|
| 140 | {
|
---|
| 141 | return socket;
|
---|
| 142 | }
|
---|
| 143 |
|
---|
| 144 | //------------------------------------------------------------------------------
|
---|
| 145 |
|
---|
| 146 | inline Failable& Connector::getFailable()
|
---|
| 147 | {
|
---|
| 148 | return socket;
|
---|
| 149 | }
|
---|
| 150 |
|
---|
| 151 | //------------------------------------------------------------------------------
|
---|
| 152 |
|
---|
| 153 | } /* namespace hu::varadiistvan::scpl::io */ } /* namespace hu::varadiistvan::scpl */ } /* namespace hu::varadiistvan */ } /* namespace hu */
|
---|
| 154 |
|
---|
| 155 | //------------------------------------------------------------------------------
|
---|
| 156 | #endif // HU_VARADIISTVAN_SCPL_IO_POSIX_CONNECTOR_H
|
---|
| 157 |
|
---|
| 158 | // Local Variables:
|
---|
| 159 | // mode: C++
|
---|
| 160 | // c-basic-offset: 4
|
---|
| 161 | // indent-tabs-mode: nil
|
---|
| 162 | // End:
|
---|