command.hpp 5.6 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/>.
*/

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

33
#include <string>
Martin Sustrik's avatar
Martin Sustrik committed
34 35
#include "stdint.hpp"

Martin Sustrik's avatar
Martin Sustrik committed
36
namespace zmq
Martin Sustrik's avatar
Martin Sustrik committed
37 38
{

39 40 41 42 43 44
    class object_t;
    class own_t;
    struct i_engine;
    class pipe_t;
    class socket_base_t;

Martin Sustrik's avatar
Martin Sustrik committed
45 46
    //  This structure defines the commands that can be sent between threads.

47
#ifdef _MSC_VER
48 49 50
#pragma warning(push)
#pragma warning(disable: 4324) // C4324: alignment padding warnings
    __declspec(align(64))
51
#endif
52
    struct command_t
Martin Sustrik's avatar
Martin Sustrik committed
53 54
    {
        //  Object to process the command.
55
        zmq::object_t *destination;
Martin Sustrik's avatar
Martin Sustrik committed
56 57 58 59

        enum type_t
        {
            stop,
60 61
            plug,
            own,
62
            attach,
Martin Sustrik's avatar
Martin Sustrik committed
63
            bind,
64 65
            activate_read,
            activate_write,
66
            hiccup,
Martin Sustrik's avatar
Martin Sustrik committed
67 68
            pipe_term,
            pipe_term_ack,
69
            pipe_hwm,
70 71
            term_req,
            term,
72
            term_ack,
73
            term_endpoint,
74
            reap,
75
            reaped,
76
            inproc_connected,
77
            done
Martin Sustrik's avatar
Martin Sustrik committed
78 79
        } type;

80 81
        union args_t
        {
Martin Sustrik's avatar
Martin Sustrik committed
82

83 84
            //  Sent to I/O thread to let it know that it should
            //  terminate itself.
Martin Sustrik's avatar
Martin Sustrik committed
85 86 87
            struct {
            } stop;

88
            //  Sent to I/O object to make it register with its I/O thread.
Martin Sustrik's avatar
Martin Sustrik committed
89
            struct {
90
            } plug;
Martin Sustrik's avatar
Martin Sustrik committed
91

92
            //  Sent to socket to let it know about the newly created object.
Martin Sustrik's avatar
Martin Sustrik committed
93
            struct {
94
                zmq::own_t *object;
95
            } own;
Martin Sustrik's avatar
Martin Sustrik committed
96

97 98
            //  Attach the engine to the session. If engine is NULL, it informs
            //  session that the connection have failed.
99
            struct {
100
                struct i_engine *engine;
101 102
            } attach;

Martin Sustrik's avatar
Martin Sustrik committed
103
            //  Sent from session to socket to establish pipe(s) between them.
104
            //  Caller have used inc_seqnum beforehand sending the command.
Martin Sustrik's avatar
Martin Sustrik committed
105
            struct {
106
                zmq::pipe_t *pipe;
107
            } bind;
Martin Sustrik's avatar
Martin Sustrik committed
108

Martin Sustrik's avatar
Martin Sustrik committed
109 110 111
            //  Sent by pipe writer to inform dormant pipe reader that there
            //  are messages in the pipe.
            struct {
112
            } activate_read;
Martin Sustrik's avatar
Martin Sustrik committed
113

114 115
            //  Sent by pipe reader to inform pipe writer about how many
            //  messages it has read so far.
Martin Hurton's avatar
Martin Hurton committed
116 117
            struct {
                uint64_t msgs_read;
118
            } activate_write;
Martin Hurton's avatar
Martin Hurton committed
119

120 121 122 123 124 125 126
            //  Sent by pipe reader to writer after creating a new inpipe.
            //  The parameter is actually of type pipe_t::upipe_t, however,
            //  its definition is private so we'll have to do with void*.
            struct {
                void *pipe;
            } hiccup;

Martin Sustrik's avatar
Martin Sustrik committed
127 128 129 130 131 132 133 134 135
            //  Sent by pipe reader to pipe writer to ask it to terminate
            //  its end of the pipe.
            struct {
            } pipe_term;

            //  Pipe writer acknowledges pipe_term command.
            struct {
            } pipe_term_ack;

136 137 138 139 140 141
            //  Sent by one of pipe to another part for modify hwm
            struct {
                int inhwm;
                int outhwm;
            } pipe_hwm;

142 143
            //  Sent by I/O object ot the socket to request the shutdown of
            //  the I/O object.
Martin Sustrik's avatar
Martin Sustrik committed
144
            struct {
145
                zmq::own_t *object;
146
            } term_req;
Martin Sustrik's avatar
Martin Sustrik committed
147

148
            //  Sent by socket to I/O object to start its shutdown.
Martin Sustrik's avatar
Martin Sustrik committed
149
            struct {
150
                int linger;
151
            } term;
Martin Sustrik's avatar
Martin Sustrik committed
152

153 154
            //  Sent by I/O object to the socket to acknowledge it has
            //  shut down.
Martin Sustrik's avatar
Martin Sustrik committed
155
            struct {
156
            } term_ack;
Martin Sustrik's avatar
Martin Sustrik committed
157

158 159 160 161 162 163
            //  Sent by session_base (I/O thread) to socket (application thread)
            //  to ask to disconnect the endpoint.
            struct {
                std::string *endpoint;
            } term_endpoint;

164 165 166
            //  Transfers the ownership of the closed socket
            //  to the reaper thread.
            struct {
167
                zmq::socket_base_t *socket;
168 169
            } reap;

170 171 172 173
            //  Closed socket notifies the reaper that it's already deallocated.
            struct {
            } reaped;

174 175 176 177 178
            //  Sent by reaper thread to the term thread when all the sockets
            //  are successfully deallocated.
            struct {
            } done;

Martin Sustrik's avatar
Martin Sustrik committed
179
        } args;
180
#ifdef _MSC_VER
Martin Sustrik's avatar
Martin Sustrik committed
181
    };
182
#pragma warning(pop)
183 184 185
#else
    } __attribute__((aligned(64)));
#endif
186
}
Martin Sustrik's avatar
Martin Sustrik committed
187 188

#endif