socket_base.hpp 10.3 KB
Newer Older
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 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
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.
25

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

#ifndef __ZMQ_SOCKET_BASE_HPP_INCLUDED__
#define __ZMQ_SOCKET_BASE_HPP_INCLUDED__

33
#include <string>
34
#include <map>
35
#include <stdarg.h>
36

37
#include "own.hpp"
38
#include "array.hpp"
39
#include "blob.hpp"
Martin Sustrik's avatar
Martin Sustrik committed
40
#include "stdint.hpp"
41
#include "poller.hpp"
42
#include "atomic_counter.hpp"
43
#include "i_poll_events.hpp"
somdoron's avatar
somdoron committed
44
#include "i_mailbox.hpp"
45
#include "stdint.hpp"
46
#include "clock.hpp"
47
#include "pipe.hpp"
48

49 50 51 52 53
extern "C"
{
    void zmq_free_event (void *data, void *hint);
}

54 55 56
namespace zmq
{

57 58 59 60
    class ctx_t;
    class msg_t;
    class pipe_t;

61
    class socket_base_t :
62
        public own_t,
63
        public array_item_t <>,
64 65
        public i_poll_events,
        public i_pipe_events
66
    {
67 68
        friend class reaper_t;

69 70
    public:

71 72 73
        //  Returns false if object is not a socket.
        bool check_tag ();

74
        //  Create a socket of a specified type.
75
        static socket_base_t *create (int type_, zmq::ctx_t *parent_,
76
            uint32_t tid_, int sid_);
77

78
        //  Returns the mailbox associated with this socket.
somdoron's avatar
somdoron committed
79
        i_mailbox *get_mailbox ();
80 81 82 83

        //  Interrupt blocking call if the socket is stuck in one.
        //  This function can be called from a different thread!
        void stop ();
84

85
        //  Interface for communication with the API layer.
86 87
        int setsockopt (int option_, const void *optval_, size_t optvallen_);
        int getsockopt (int option_, void *optval_, size_t *optvallen_);
88 89
        int bind (const char *addr_);
        int connect (const char *addr_);
90
        int term_endpoint (const char *addr_);
91 92
        int send (zmq::msg_t *msg_, int flags_);
        int recv (zmq::msg_t *msg_, int flags_);
93 94
        int add_signaler (signaler_t *s);
        int remove_signaler (signaler_t *s);
95
        int close ();
96

97 98 99 100 101
        //  These functions are used by the polling mechanism to determine
        //  which events are to be reported from this socket.
        bool has_in ();
        bool has_out ();

somdoron's avatar
somdoron committed
102 103 104 105
        //  Joining and leaving groups
        int join (const char *group);
        int leave (const char *group);

106
        //  Using this function reaper thread ask the socket to register with
107 108 109 110 111 112 113 114
        //  its poller.
        void start_reaping (poller_t *poller_);

        //  i_poll_events implementation. This interface is used when socket
        //  is handled by the poller in the reaper thread.
        void in_event ();
        void out_event ();
        void timer_event (int id_);
Martin Sustrik's avatar
Martin Sustrik committed
115

116 117 118
        //  i_pipe_events interface implementation.
        void read_activated (pipe_t *pipe_);
        void write_activated (pipe_t *pipe_);
119
        void hiccuped (pipe_t *pipe_);
120
        void pipe_terminated (pipe_t *pipe_);
skaller's avatar
skaller committed
121 122
        void lock();
        void unlock();
123

124 125
        int monitor (const char *endpoint_, int events_);

126 127 128
        void set_fd(fd_t fd_);
        fd_t fd();

Martin Hurton's avatar
Martin Hurton committed
129 130 131 132 133 134 135 136 137 138
        void event_connected (const std::string &addr_, int fd_);
        void event_connect_delayed (const std::string &addr_, int err_);
        void event_connect_retried (const std::string &addr_, int interval_);
        void event_listening (const std::string &addr_, int fd_);
        void event_bind_failed (const std::string &addr_, int err_);
        void event_accepted (const std::string &addr_, int fd_);
        void event_accept_failed (const std::string &addr_, int err_);
        void event_closed (const std::string &addr_, int fd_);
        void event_close_failed (const std::string &addr_, int fd_);
        void event_disconnected (const std::string &addr_, int fd_);
139

140 141
    protected:

somdoron's avatar
somdoron committed
142
        socket_base_t (zmq::ctx_t *parent_, uint32_t tid_, int sid_, bool thread_safe_ = false);
143 144
        virtual ~socket_base_t ();

145 146
        //  Concrete algorithms for the x- methods are to be defined by
        //  individual socket types.
147
        virtual void xattach_pipe (zmq::pipe_t *pipe_,
148
            bool subscribe_to_all_ = false) = 0;
149

150
        //  The default implementation assumes there are no specific socket
151
        //  options for the particular socket type. If not so, override this
152
        //  method.
153
        virtual int xsetsockopt (int option_, const void *optval_,
154 155 156 157
            size_t optvallen_);

        //  The default implementation assumes that send is not supported.
        virtual bool xhas_out ();
158
        virtual int xsend (zmq::msg_t *msg_);
159 160 161

        //  The default implementation assumes that recv in not supported.
        virtual bool xhas_in ();
162
        virtual int xrecv (zmq::msg_t *msg_);
Martin Sustrik's avatar
Martin Sustrik committed
163

164 165 166 167 168
        //  Returns the credential for the peer from which we have received
        //  the last message. If no message has been received yet,
        //  the function returns empty credential.
        virtual blob_t get_credential () const;

169 170 171
        //  i_pipe_events will be forwarded to these functions.
        virtual void xread_activated (pipe_t *pipe_);
        virtual void xwrite_activated (pipe_t *pipe_);
172
        virtual void xhiccuped (pipe_t *pipe_);
173
        virtual void xpipe_terminated (pipe_t *pipe_) = 0;
174

somdoron's avatar
somdoron committed
175 176 177 178
        //  the default implementation assumes that joub and leave are not supported.
        virtual int xjoin (const char *group_);
        virtual int xleave (const char *group_);

179 180 181
        //  Delay actual destruction of the socket.
        void process_destroy ();

182
        // Socket event data dispatch
183
        void monitor_event (int event_, int value_, const std::string& addr_);
184

185
        // Monitor socket cleanup
186
        void stop_monitor (bool send_monitor_stopped_event_ = true);
somdoron's avatar
somdoron committed
187

188
        // Next assigned name on a zmq_connect() call used by ROUTER and STREAM socket types
189 190
        std::string connect_rid;

191
    private:
192
        //  Creates new endpoint ID and adds the endpoint to the map.
193
        void add_endpoint (const char *addr_, own_t *endpoint_, pipe_t *pipe);
194 195

        //  Map of open endpoints.
196 197
        typedef std::pair <own_t *, pipe_t*> endpoint_pipe_t;
        typedef std::multimap <std::string, endpoint_pipe_t> endpoints_t;
198
        endpoints_t endpoints;
199

200 201 202 203
        //  Map of open inproc endpoints.
        typedef std::multimap <std::string, pipe_t *> inprocs_t;
        inprocs_t inprocs;

204 205 206 207
        //  To be called after processing commands or invoking any command
        //  handlers explicitly. If required, it will deallocate the socket.
        void check_destroy ();

208 209 210 211
        //  Moves the flags from the message to local variables,
        //  to be later retrieved by getsockopt.
        void extract_flags (msg_t *msg_);

212 213 214
        //  Used to check whether the object is a socket.
        uint32_t tag;

215 216
        //  If true, associated context was already terminated.
        bool ctx_terminated;
217

218 219 220 221 222
        //  If true, object should have been already destroyed. However,
        //  destruction is delayed while we unwind the stack to the point
        //  where it doesn't intersect the object being destroyed.
        bool destroyed;

223 224 225 226
        //  Parse URI string.
        int parse_uri (const char *uri_, std::string &protocol_,
            std::string &address_);

227 228 229
        //  Check whether transport protocol, as specified in connect or
        //  bind, is available and compatible with the socket type.
        int check_protocol (const std::string &protocol_);
230

231
        //  Register the pipe with this socket.
232
        void attach_pipe (zmq::pipe_t *pipe_, bool subscribe_to_all_ = false);
233

234 235
        //  Processes commands sent to this socket (if any). If timeout is -1,
        //  returns only after at least one command was processed.
236 237
        //  If throttle argument is true, commands are processed at most once
        //  in a predefined time period.
238
        int process_commands (int timeout_, bool throttle_);
239

240
        //  Handlers for incoming commands.
241
        void process_stop ();
242
        void process_bind (zmq::pipe_t *pipe_);
243
        void process_term (int linger_);
244

245 246
        void update_pipe_options(int option_);

247
        //  Socket's mailbox object.
248
        i_mailbox *mailbox;
249

250 251 252 253
        //  List of attached pipes.
        typedef array_t <pipe_t, 3> pipes_t;
        pipes_t pipes;

254 255 256 257
        //  Reaper's poller and handle of this socket within it.
        poller_t *poller;
        poller_t::handle_t handle;

258
        //  Timestamp of when commands were processed the last time.
Martin Sustrik's avatar
Martin Sustrik committed
259
        uint64_t last_tsc;
260

Martin Sustrik's avatar
Martin Sustrik committed
261 262 263
        //  Number of messages received since last command processing.
        int ticks;

264
        //  True if the last message received had MORE flag set.
265 266
        bool rcvmore;

267 268
        // File descriptor if applicable
        fd_t file_desc;
269

270 271 272
        //  Improves efficiency of time measurement.
        clock_t clock;

273 274 275 276 277 278
        // Monitor socket;
        void *monitor_socket;

        // Bitmask of events being monitored
        int monitor_events;

279 280 281
        // Last socket endpoint resolved URI
        std::string last_endpoint;

somdoron's avatar
somdoron committed
282 283 284 285
        // Indicate if the socket is thread safe
        bool thread_safe;

        // Signaler to be used in the reaping stage
286
        signaler_t* reaper_signaler;
somdoron's avatar
somdoron committed
287 288

        // Mutex for synchronize access to the socket in thread safe mode
skaller's avatar
skaller committed
289
        mutex_t sync;
somdoron's avatar
somdoron committed
290 291

        socket_base_t (const socket_base_t&);
somdoron's avatar
somdoron committed
292
        const socket_base_t &operator = (const socket_base_t&);
293 294 295 296 297
    };

}

#endif