1/*
2 Copyright (c) 2007-2016 Contributors as noted in the AUTHORS file
3
4 This file is part of libzmq, the ZeroMQ core engine in C++.
5
6 libzmq is free software; you can redistribute it and/or modify it under
7 the terms of the GNU Lesser General Public License (LGPL) as published
8 by the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
10
11 As a special exception, the Contributors give you permission to link
12 this library with independent modules to produce an executable,
13 regardless of the license terms of these independent modules, and to
14 copy and distribute the resulting executable under terms of your choice,
15 provided that you also meet, for each linked independent module, the
16 terms and conditions of the license of that module. An independent
17 module is a module which is not derived from or based on this library.
18 If you modify this library, you must extend this exception to your
19 version of the library.
20
21 libzmq is distributed in the hope that it will be useful, but WITHOUT
22 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
23 FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
24 License for more details.
25
26 You should have received a copy of the GNU Lesser General Public License
27 along with this program. If not, see <http://www.gnu.org/licenses/>.
28*/
29
30#ifndef __ZMQ_VMCI_CONNECTER_HPP_INCLUDED__
31#define __ZMQ_VMCI_CONNECTER_HPP_INCLUDED__
32
33#include "platform.hpp"
34
35#if defined ZMQ_HAVE_VMCI
36
37#include "fd.hpp"
38#include "own.hpp"
39#include "stdint.hpp"
40#include "io_object.hpp"
41
42namespace zmq
43{
44class io_thread_t;
45class session_base_t;
46struct address_t;
47
48// TODO consider refactoring this to derive from stream_connecter_base_t
49class vmci_connecter_t : public own_t, public io_object_t
50{
51 public:
52 // If 'delayed_start' is true connecter first waits for a while,
53 // then starts connection process.
54 vmci_connecter_t (zmq::io_thread_t *io_thread_,
55 zmq::session_base_t *session_,
56 const options_t &options_,
57 const address_t *addr_,
58 bool delayed_start_);
59 ~vmci_connecter_t ();
60
61 private:
62 // ID of the timer used to delay the reconnection.
63 enum
64 {
65 reconnect_timer_id = 1
66 };
67
68 // Handlers for incoming commands.
69 void process_plug ();
70 void process_term (int linger_);
71
72 // Handlers for I/O events.
73 void in_event ();
74 void out_event ();
75 void timer_event (int id_);
76
77 // Internal function to start the actual connection establishment.
78 void start_connecting ();
79
80 // Internal function to add a reconnect timer
81 void add_reconnect_timer ();
82
83 // Internal function to return a reconnect backoff delay.
84 // Will modify the current_reconnect_ivl used for next call
85 // Returns the currently used interval
86 int get_new_reconnect_ivl ();
87
88 // Open VMCI connecting socket. Returns -1 in case of error,
89 // 0 if connect was successful immediately. Returns -1 with
90 // EAGAIN errno if async connect was launched.
91 int open ();
92
93 // Close the connecting socket.
94 void close ();
95
96 // Get the file descriptor of newly created connection. Returns
97 // retired_fd if the connection was unsuccessful.
98 fd_t connect ();
99
100 // Address to connect to. Owned by session_base_t.
101 const address_t *addr;
102
103 // Underlying socket.
104 fd_t s;
105
106 // Handle corresponding to the listening socket.
107 handle_t handle;
108
109 // If true file descriptor is registered with the poller and 'handle'
110 // contains valid value.
111 bool handle_valid;
112
113 // If true, connecter is waiting a while before trying to connect.
114 const bool delayed_start;
115
116 // True iff a timer has been started.
117 bool timer_started;
118
119 // Reference to the session we belong to.
120 zmq::session_base_t *session;
121
122 // Current reconnect ivl, updated for backoff strategy
123 int current_reconnect_ivl;
124
125 // String representation of endpoint to connect to
126 std::string endpoint;
127
128 // Socket
129 zmq::socket_base_t *socket;
130
131 ZMQ_NON_COPYABLE_NOR_MOVABLE (vmci_connecter_t)
132};
133}
134
135#endif
136
137#endif
138