vmci_connecter.hpp 4.15 KB
Newer Older
Ilya Kulakov's avatar
Ilya Kulakov committed
1
/*
2
    Copyright (c) 2007-2016 Contributors as noted in the AUTHORS file
Ilya Kulakov's avatar
Ilya Kulakov committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29

    This file is part of libzmq, the ZeroMQ core engine in C++.

    libzmq is free software; you can redistribute it and/or modify it under
    the terms of the GNU Lesser General Public License (LGPL) as published
    by the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.

    As a special exception, the Contributors give you permission to link
    this library with independent modules to produce an executable,
    regardless of the license terms of these independent modules, and to
    copy and distribute the resulting executable under terms of your choice,
    provided that you also meet, for each linked independent module, the
    terms and conditions of the license of that module. An independent
    module is a module which is not derived from or based on this library.
    If you modify this library, you must extend this exception to your
    version of the library.

    libzmq is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
    License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

30 31
#ifndef __ZMQ_VMCI_CONNECTER_HPP_INCLUDED__
#define __ZMQ_VMCI_CONNECTER_HPP_INCLUDED__
Ilya Kulakov's avatar
Ilya Kulakov committed
32 33 34 35 36 37 38 39 40 41 42 43

#include "platform.hpp"

#if defined ZMQ_HAVE_VMCI

#include "fd.hpp"
#include "own.hpp"
#include "stdint.hpp"
#include "io_object.hpp"

namespace zmq
{
44 45 46
class io_thread_t;
class session_base_t;
struct address_t;
Ilya Kulakov's avatar
Ilya Kulakov committed
47

48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
class vmci_connecter_t : public own_t, public io_object_t
{
  public:
    //  If 'delayed_start' is true connecter first waits for a while,
    //  then starts connection process.
    vmci_connecter_t (zmq::io_thread_t *io_thread_,
                      zmq::session_base_t *session_,
                      const options_t &options_,
                      const address_t *addr_,
                      bool delayed_start_);
    ~vmci_connecter_t ();

  private:
    //  ID of the timer used to delay the reconnection.
    enum
Ilya Kulakov's avatar
Ilya Kulakov committed
63
    {
64 65
        reconnect_timer_id = 1
    };
Ilya Kulakov's avatar
Ilya Kulakov committed
66

67 68 69
    //  Handlers for incoming commands.
    void process_plug ();
    void process_term (int linger_);
Ilya Kulakov's avatar
Ilya Kulakov committed
70

71 72 73 74
    //  Handlers for I/O events.
    void in_event ();
    void out_event ();
    void timer_event (int id_);
Ilya Kulakov's avatar
Ilya Kulakov committed
75

76 77
    //  Internal function to start the actual connection establishment.
    void start_connecting ();
Ilya Kulakov's avatar
Ilya Kulakov committed
78

79 80
    //  Internal function to add a reconnect timer
    void add_reconnect_timer ();
Ilya Kulakov's avatar
Ilya Kulakov committed
81

82 83 84 85
    //  Internal function to return a reconnect backoff delay.
    //  Will modify the current_reconnect_ivl used for next call
    //  Returns the currently used interval
    int get_new_reconnect_ivl ();
Ilya Kulakov's avatar
Ilya Kulakov committed
86

87 88 89 90
    //  Open VMCI connecting socket. Returns -1 in case of error,
    //  0 if connect was successful immediately. Returns -1 with
    //  EAGAIN errno if async connect was launched.
    int open ();
Ilya Kulakov's avatar
Ilya Kulakov committed
91

92 93
    //  Close the connecting socket.
    void close ();
Ilya Kulakov's avatar
Ilya Kulakov committed
94

95 96 97
    //  Get the file descriptor of newly created connection. Returns
    //  retired_fd if the connection was unsuccessful.
    fd_t connect ();
Ilya Kulakov's avatar
Ilya Kulakov committed
98

99 100
    //  Address to connect to. Owned by session_base_t.
    const address_t *addr;
Ilya Kulakov's avatar
Ilya Kulakov committed
101

102 103
    //  Underlying socket.
    fd_t s;
Ilya Kulakov's avatar
Ilya Kulakov committed
104

105 106
    //  Handle corresponding to the listening socket.
    handle_t handle;
Ilya Kulakov's avatar
Ilya Kulakov committed
107

108 109 110
    //  If true file descriptor is registered with the poller and 'handle'
    //  contains valid value.
    bool handle_valid;
Ilya Kulakov's avatar
Ilya Kulakov committed
111

112 113
    //  If true, connecter is waiting a while before trying to connect.
    const bool delayed_start;
Ilya Kulakov's avatar
Ilya Kulakov committed
114

115 116
    //  True iff a timer has been started.
    bool timer_started;
Ilya Kulakov's avatar
Ilya Kulakov committed
117

118 119
    //  Reference to the session we belong to.
    zmq::session_base_t *session;
Ilya Kulakov's avatar
Ilya Kulakov committed
120

121 122
    //  Current reconnect ivl, updated for backoff strategy
    int current_reconnect_ivl;
Ilya Kulakov's avatar
Ilya Kulakov committed
123

124 125
    // String representation of endpoint to connect to
    std::string endpoint;
Ilya Kulakov's avatar
Ilya Kulakov committed
126

127 128
    // Socket
    zmq::socket_base_t *socket;
Ilya Kulakov's avatar
Ilya Kulakov committed
129

130 131 132
    vmci_connecter_t (const vmci_connecter_t &);
    const vmci_connecter_t &operator= (const vmci_connecter_t &);
};
Ilya Kulakov's avatar
Ilya Kulakov committed
133 134 135 136 137
}

#endif

#endif