tcp_connecter.hpp 4.29 KB
Newer Older
Martin Sustrik's avatar
Martin Sustrik committed
1
/*
2
    Copyright (c) 2007-2016 Contributors as noted in the AUTHORS file
Martin Sustrik's avatar
Martin Sustrik committed
3

4
    This file is part of libzmq, the ZeroMQ core engine in C++.
Martin Sustrik's avatar
Martin Sustrik committed
5

6 7 8
    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
Martin Sustrik's avatar
Martin Sustrik committed
9 10
    (at your option) any later version.

11 12 13 14 15 16 17 18 19 20 21 22 23 24
    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.
Martin Sustrik's avatar
Martin Sustrik committed
25

26
    You should have received a copy of the GNU Lesser General Public License
Martin Sustrik's avatar
Martin Sustrik committed
27 28 29
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

30 31
#ifndef __TCP_CONNECTER_HPP_INCLUDED__
#define __TCP_CONNECTER_HPP_INCLUDED__
Martin Sustrik's avatar
Martin Sustrik committed
32 33

#include "fd.hpp"
34 35
#include "own.hpp"
#include "stdint.hpp"
36
#include "io_object.hpp"
Martin Sustrik's avatar
Martin Sustrik committed
37

Martin Sustrik's avatar
Martin Sustrik committed
38
namespace zmq
Martin Sustrik's avatar
Martin Sustrik committed
39
{
40 41 42
class io_thread_t;
class session_base_t;
struct address_t;
Martin Sustrik's avatar
Martin Sustrik committed
43

44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
class tcp_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.
    tcp_connecter_t (zmq::io_thread_t *io_thread_,
                     zmq::session_base_t *session_,
                     const options_t &options_,
                     address_t *addr_,
                     bool delayed_start_);
    ~tcp_connecter_t ();

  private:
    //  ID of the timer used to delay the reconnection.
    enum
Martin Sustrik's avatar
Martin Sustrik committed
59
    {
60 61 62
        reconnect_timer_id = 1,
        connect_timer_id
    };
63

64 65 66
    //  Handlers for incoming commands.
    void process_plug ();
    void process_term (int linger_);
67

68 69 70 71
    //  Handlers for I/O events.
    void in_event ();
    void out_event ();
    void timer_event (int id_);
72

73 74 75
    //  Removes the handle from the poller.
    void rm_handle ();

76 77
    //  Internal function to start the actual connection establishment.
    void start_connecting ();
78

79 80
    //  Internal function to add a connect timer
    void add_connect_timer ();
81

82 83
    //  Internal function to add a reconnect timer
    void add_reconnect_timer ();
84

85 86 87 88
    //  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 ();
Martin Sustrik's avatar
Martin Sustrik committed
89

90 91 92 93
    //  Open TCP 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 ();
Martin Sustrik's avatar
Martin Sustrik committed
94

95 96
    //  Close the connecting socket.
    void close ();
Martin Sustrik's avatar
Martin Sustrik committed
97

98 99 100
    //  Get the file descriptor of newly created connection. Returns
    //  retired_fd if the connection was unsuccessful.
    fd_t connect ();
101

102 103 104
    //  Tunes a connected socket.
    bool tune_socket (fd_t fd);

105
    //  Address to connect to. Owned by session_base_t.
106
    address_t *const addr;
Martin Sustrik's avatar
Martin Sustrik committed
107

108 109
    //  Underlying socket.
    fd_t s;
110

111
    //  Handle corresponding to the listening socket, if file descriptor is
112
    //  registered with the poller, or NULL.
113
    handle_t handle;
114

115 116
    //  If true, connecter is waiting a while before trying to connect.
    const bool delayed_start;
117

118 119 120
    //  True iff a timer has been started.
    bool connect_timer_started;
    bool reconnect_timer_started;
121

122
    //  Reference to the session we belong to.
123
    zmq::session_base_t *const session;
124

125 126
    //  Current reconnect ivl, updated for backoff strategy
    int current_reconnect_ivl;
127

128 129
    // String representation of endpoint to connect to
    std::string endpoint;
130

131
    // Socket
132
    zmq::socket_base_t *const socket;
Martin Sustrik's avatar
Martin Sustrik committed
133

134 135 136
    tcp_connecter_t (const tcp_connecter_t &);
    const tcp_connecter_t &operator= (const tcp_connecter_t &);
};
Martin Sustrik's avatar
Martin Sustrik committed
137 138 139
}

#endif