command.hpp 5.26 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 34

#include "stdint.hpp"

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

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

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

46 47 48
#ifdef _MSC_VER
    __declspec(align(64)) struct command_t
#else
Martin Sustrik's avatar
Martin Sustrik committed
49
    struct command_t
50
#endif
Martin Sustrik's avatar
Martin Sustrik committed
51 52
    {
        //  Object to process the command.
53
        zmq::object_t *destination;
Martin Sustrik's avatar
Martin Sustrik committed
54 55 56 57

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

77 78
        union args_t
        {
Martin Sustrik's avatar
Martin Sustrik committed
79

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

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

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

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

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

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

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

117 118 119 120 121 122 123
            //  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
124 125 126 127 128 129 130 131 132
            //  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;

133 134 135 136 137 138
            //  Sent by one of pipe to another part for modify hwm
            struct {
                int inhwm;
                int outhwm;
            } pipe_hwm;

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

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

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

155 156 157
            //  Transfers the ownership of the closed socket
            //  to the reaper thread.
            struct {
158
                zmq::socket_base_t *socket;
159 160
            } reap;

161 162 163 164
            //  Closed socket notifies the reaper that it's already deallocated.
            struct {
            } reaped;

165 166 167 168 169
            //  Sent by reaper thread to the term thread when all the sockets
            //  are successfully deallocated.
            struct {
            } done;

Martin Sustrik's avatar
Martin Sustrik committed
170
        } args;
171
#ifdef _MSC_VER
Martin Sustrik's avatar
Martin Sustrik committed
172
    };
173 174 175
#else
    } __attribute__((aligned(64)));
#endif
176
}
Martin Sustrik's avatar
Martin Sustrik committed
177 178

#endif