tcp_connecter.hpp 4.36 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;
43
    struct address_t;
44

45
    class tcp_connecter_t : public own_t, public io_object_t
Martin Sustrik's avatar
Martin Sustrik committed
46 47 48
    {
    public:

49 50
        //  If 'delayed_start' is true connecter first waits for a while,
        //  then starts connection process.
51 52
        tcp_connecter_t (zmq::io_thread_t *io_thread_,
            zmq::session_base_t *session_, const options_t &options_,
53
            address_t *addr_, bool delayed_start_);
Martin Sustrik's avatar
Martin Sustrik committed
54 55
        ~tcp_connecter_t ();

56 57 58
    private:

        //  ID of the timer used to delay the reconnection.
59
        enum {reconnect_timer_id = 1, connect_timer_id};
60 61 62

        //  Handlers for incoming commands.
        void process_plug ();
63
        void process_term (int linger_);
64 65 66 67 68 69 70 71 72

        //  Handlers for I/O events.
        void in_event ();
        void out_event ();
        void timer_event (int id_);

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

73 74 75
        //  Internal function to add a connect timer
        void add_connect_timer();

76 77 78 79 80 81 82 83
        //  Internal function to add a reconnect timer
        void add_reconnect_timer();

        //  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 ();

84
        //  Open TCP connecting socket. Returns -1 in case of error,
85
        //  0 if connect was successful immediately. Returns -1 with
86
        //  EAGAIN errno if async connect was launched.
87
        int open ();
Martin Sustrik's avatar
Martin Sustrik committed
88 89

        //  Close the connecting socket.
90
        void close ();
Martin Sustrik's avatar
Martin Sustrik committed
91 92

        //  Get the file descriptor of newly created connection. Returns
93
        //  retired_fd if the connection was unsuccessful.
Martin Sustrik's avatar
Martin Sustrik committed
94 95
        fd_t connect ();

96
        //  Address to connect to. Owned by session_base_t.
97
        address_t *addr;
98

Martin Sustrik's avatar
Martin Sustrik committed
99 100 101
        //  Underlying socket.
        fd_t s;

102 103 104 105 106 107 108 109
        //  Handle corresponding to the listening socket.
        handle_t handle;

        //  If true file descriptor is registered with the poller and 'handle'
        //  contains valid value.
        bool handle_valid;

        //  If true, connecter is waiting a while before trying to connect.
110 111 112
        const bool delayed_start;

        //  True iff a timer has been started.
113
        bool connect_timer_started;
114
        bool reconnect_timer_started;
115 116

        //  Reference to the session we belong to.
117
        zmq::session_base_t *session;
118 119 120 121

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

122 123 124
        // String representation of endpoint to connect to
        std::string endpoint;

125 126 127
        // Socket
        zmq::socket_base_t *socket;

Martin Sustrik's avatar
Martin Sustrik committed
128
        tcp_connecter_t (const tcp_connecter_t&);
129
        const tcp_connecter_t &operator = (const tcp_connecter_t&);
Martin Sustrik's avatar
Martin Sustrik committed
130 131 132 133 134
    };

}

#endif