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

    This file is part of 0MQ.

    0MQ is free software; you can redistribute it and/or modify it under
7
    the terms of the GNU Lesser General Public License as published by
Martin Sustrik's avatar
Martin Sustrik committed
8 9 10 11 12 13
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.

    0MQ 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
14
    GNU Lesser General Public License for more details.
Martin Sustrik's avatar
Martin Sustrik committed
15

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

20 21
#ifndef __TCP_CONNECTER_HPP_INCLUDED__
#define __TCP_CONNECTER_HPP_INCLUDED__
Martin Sustrik's avatar
Martin Sustrik committed
22 23

#include "fd.hpp"
24 25
#include "own.hpp"
#include "stdint.hpp"
26
#include "io_object.hpp"
27
#include "../include/zmq.h"
Martin Sustrik's avatar
Martin Sustrik committed
28

Martin Sustrik's avatar
Martin Sustrik committed
29
namespace zmq
Martin Sustrik's avatar
Martin Sustrik committed
30 31
{

32 33
    class io_thread_t;
    class session_base_t;
34
    struct address_t;
35

36
    class tcp_connecter_t : public own_t, public io_object_t
Martin Sustrik's avatar
Martin Sustrik committed
37 38 39
    {
    public:

40 41
        //  If 'delayed_start' is true connecter first waits for a while,
        //  then starts connection process.
42 43
        tcp_connecter_t (zmq::io_thread_t *io_thread_,
            zmq::session_base_t *session_, const options_t &options_,
44
            const address_t *addr_, bool delayed_start_);
Martin Sustrik's avatar
Martin Sustrik committed
45 46
        ~tcp_connecter_t ();

47 48 49 50 51 52 53
    private:

        //  ID of the timer used to delay the reconnection.
        enum {reconnect_timer_id = 1};

        //  Handlers for incoming commands.
        void process_plug ();
54
        void process_term (int linger_);
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71

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

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

72
        //  Open TCP connecting socket. Returns -1 in case of error,
73 74
        //  0 if connect was successfull immediately. Returns -1 with
        //  EAGAIN errno if async connect was launched.
75
        int open ();
Martin Sustrik's avatar
Martin Sustrik committed
76 77

        //  Close the connecting socket.
78
        void close ();
Martin Sustrik's avatar
Martin Sustrik committed
79 80 81 82 83

        //  Get the file descriptor of newly created connection. Returns
        //  retired_fd if the connection was unsuccessfull.
        fd_t connect ();

84 85
        //  Address to connect to. Owned by session_base_t.
        const address_t *addr;
86

Martin Sustrik's avatar
Martin Sustrik committed
87 88 89
        //  Underlying socket.
        fd_t s;

90 91 92 93 94 95 96 97
        //  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.
98 99 100 101
        const bool delayed_start;

        //  True iff a timer has been started.
        bool timer_started;
102 103

        //  Reference to the session we belong to.
104
        zmq::session_base_t *session;
105 106 107 108

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

109 110 111
        // String representation of endpoint to connect to
        std::string endpoint;

112 113 114
        // Socket
        zmq::socket_base_t *socket;

Martin Sustrik's avatar
Martin Sustrik committed
115
        tcp_connecter_t (const tcp_connecter_t&);
116
        const tcp_connecter_t &operator = (const tcp_connecter_t&);
Martin Sustrik's avatar
Martin Sustrik committed
117 118 119 120 121
    };

}

#endif