[21] | 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_WIN32_LOCALCONNECTOR_H
|
---|
| 31 | #define XPLCOMMON_WIN32_LOCALCONNECTOR_H
|
---|
| 32 | //------------------------------------------------------------------------------
|
---|
| 33 |
|
---|
| 34 | #include "Completer.h"
|
---|
| 35 |
|
---|
| 36 | #include "LocalSocket.h"
|
---|
| 37 |
|
---|
| 38 | //------------------------------------------------------------------------------
|
---|
| 39 |
|
---|
| 40 | namespace xplcommon { namespace win32 {
|
---|
| 41 |
|
---|
| 42 | //------------------------------------------------------------------------------
|
---|
| 43 |
|
---|
| 44 | class LocalConnector : public FailableReference<LocalConnector>
|
---|
| 45 | {
|
---|
| 46 | private:
|
---|
| 47 | /**
|
---|
| 48 | * The local socket to connect on behalf of which (it should
|
---|
| 49 | * actually be a LocalClientSocket.
|
---|
| 50 | */
|
---|
| 51 | LocalSocket& socket;
|
---|
| 52 |
|
---|
| 53 | /**
|
---|
[22] | 54 | * The path of the pipe to connect to.
|
---|
[21] | 55 | */
|
---|
[22] | 56 | char path[256];
|
---|
[21] | 57 |
|
---|
| 58 | /**
|
---|
| 59 | * Indicate if we are connected.
|
---|
| 60 | */
|
---|
| 61 | bool connected;
|
---|
| 62 |
|
---|
| 63 | protected:
|
---|
| 64 | /**
|
---|
| 65 | * Construct the connector.
|
---|
| 66 | */
|
---|
| 67 | LocalConnector(LocalSocket* socket, const char* name);
|
---|
| 68 |
|
---|
| 69 | public:
|
---|
| 70 | /**
|
---|
| 71 | * Connect to an address properly set up.
|
---|
| 72 | *
|
---|
| 73 | * If the connection succeeds immediately, it indicates success.
|
---|
| 74 | *
|
---|
| 75 | * If the connection does not succeed, because it would block, it
|
---|
| 76 | * sets up the socket to wait for the connection to succeed, and
|
---|
| 77 | * returns failure.
|
---|
| 78 | *
|
---|
| 79 | * If the connection fails for another reason, the error code is
|
---|
| 80 | * set, and false is returned.
|
---|
| 81 | */
|
---|
| 82 | bool connect();
|
---|
| 83 |
|
---|
| 84 | private:
|
---|
| 85 | /**
|
---|
| 86 | * Get the failable object.
|
---|
| 87 | */
|
---|
| 88 | const ::xplcommon::Failable& getFailable() const;
|
---|
| 89 |
|
---|
| 90 | /**
|
---|
| 91 | * Get the failable object.
|
---|
| 92 | */
|
---|
| 93 | ::xplcommon::Failable& getFailable();
|
---|
| 94 |
|
---|
| 95 | friend class FailableReference<LocalConnector>;
|
---|
| 96 | friend class LocalClientSocket;
|
---|
| 97 | };
|
---|
| 98 |
|
---|
| 99 | //------------------------------------------------------------------------------
|
---|
| 100 | // Inline definitions
|
---|
| 101 | //------------------------------------------------------------------------------
|
---|
| 102 |
|
---|
| 103 | inline LocalConnector::LocalConnector(LocalSocket* socket, const char* name) :
|
---|
| 104 | socket(*socket),
|
---|
| 105 | connected(false)
|
---|
| 106 | {
|
---|
[22] | 107 | LocalSocket::setupPath(path, name);
|
---|
[21] | 108 | }
|
---|
| 109 |
|
---|
| 110 | //------------------------------------------------------------------------------
|
---|
| 111 |
|
---|
| 112 | inline const ::xplcommon::Failable& LocalConnector::getFailable() const
|
---|
| 113 | {
|
---|
| 114 | return socket;
|
---|
| 115 | }
|
---|
| 116 |
|
---|
| 117 | //------------------------------------------------------------------------------
|
---|
| 118 |
|
---|
| 119 | inline ::xplcommon::Failable& LocalConnector::getFailable()
|
---|
| 120 | {
|
---|
| 121 | return socket;
|
---|
| 122 | }
|
---|
| 123 |
|
---|
| 124 | //------------------------------------------------------------------------------
|
---|
| 125 |
|
---|
| 126 | } /* namespace xplcommon::win32 */ } /* namespace xplcommon */
|
---|
| 127 |
|
---|
| 128 | //------------------------------------------------------------------------------
|
---|
| 129 | #endif // XPLCOMMON_WIN32_LOCALCONNECTOR_H
|
---|
| 130 |
|
---|
| 131 | // Local Variables:
|
---|
| 132 | // mode: C++
|
---|
| 133 | // c-basic-offset: 4
|
---|
| 134 | // indent-tabs-mode: nil
|
---|
| 135 | // End:
|
---|