test_stream.cpp 11 KB
Newer Older
1
/*
2
    Copyright (c) 2007-2017 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 27 28 29

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

30
#include "testutil.hpp"
31 32 33 34

//  ZMTP protocol greeting structure

typedef unsigned char byte;
35 36 37 38 39
typedef struct
{
    byte signature[10]; //  0xFF 8*0x00 0x7F
    byte version[2];    //  0x03 0x00 for ZMTP/3.0
    byte mechanism[20]; //  "NULL"
40
    byte as_server;
41
    byte filler[31];
42 43
} zmtp_greeting_t;

44
#define ZMTP_DEALER 5 //  Socket type constants
45 46 47 48

//  This is a greeting matching what 0MQ will send us; note the
//  8-byte size is set to 1 for backwards compatibility

49 50
static zmtp_greeting_t greeting = {
  {0xFF, 0, 0, 0, 0, 0, 0, 0, 1, 0x7F}, {3, 0}, {'N', 'U', 'L', 'L'}, 0, {0}};
51

52
static void test_stream_to_dealer (void)
53 54
{
    int rc;
55 56
    size_t len = MAX_SOCKET_STRING;
    char my_endpoint[MAX_SOCKET_STRING];
57 58 59 60 61 62 63 64 65 66 67 68

    //  Set up our context and sockets
    void *ctx = zmq_ctx_new ();
    assert (ctx);

    //  We'll be using this socket in raw mode
    void *stream = zmq_socket (ctx, ZMQ_STREAM);
    assert (stream);

    int zero = 0;
    rc = zmq_setsockopt (stream, ZMQ_LINGER, &zero, sizeof (zero));
    assert (rc == 0);
69 70 71
    int enabled = 1;
    rc = zmq_setsockopt (stream, ZMQ_STREAM_NOTIFY, &enabled, sizeof (enabled));
    assert (rc == 0);
72
    rc = zmq_bind (stream, "tcp://127.0.0.1:*");
73
    assert (rc == 0);
74 75 76
    rc = zmq_getsockopt (stream, ZMQ_LAST_ENDPOINT, my_endpoint, &len);
    assert (rc == 0);

77 78 79 80 81 82

    //  We'll be using this socket as the other peer
    void *dealer = zmq_socket (ctx, ZMQ_DEALER);
    assert (dealer);
    rc = zmq_setsockopt (dealer, ZMQ_LINGER, &zero, sizeof (zero));
    assert (rc == 0);
83
    rc = zmq_connect (dealer, my_endpoint);
84 85 86 87 88

    //  Send a message on the dealer socket
    rc = zmq_send (dealer, "Hello", 5, 0);
    assert (rc == 5);

89
    //  Connecting sends a zero message
90 91 92
    //  First frame is routing id
    zmq_msg_t routing_id;
    rc = zmq_msg_init (&routing_id);
93
    assert (rc == 0);
94
    rc = zmq_msg_recv (&routing_id, stream, 0);
95
    assert (rc > 0);
96
    assert (zmq_msg_more (&routing_id));
97

98
    //  Verify the existence of Peer-Address metadata
99
    char const *peer_address = zmq_msg_gets (&routing_id, "Peer-Address");
100 101
    assert (peer_address != 0);
    assert (streq (peer_address, "127.0.0.1"));
102

103
    //  Second frame is zero
104
    byte buffer[255];
105
    rc = zmq_recv (stream, buffer, 255, 0);
106
    assert (rc == 0);
107

108
    //  Verify the existence of Peer-Address metadata
109
    peer_address = zmq_msg_gets (&routing_id, "Peer-Address");
110 111
    assert (peer_address != 0);
    assert (streq (peer_address, "127.0.0.1"));
112

113
    //  Real data follows
114 115
    //  First frame is routing id
    rc = zmq_msg_recv (&routing_id, stream, 0);
116
    assert (rc > 0);
117
    assert (zmq_msg_more (&routing_id));
118

119
    //  Verify the existence of Peer-Address metadata
120
    peer_address = zmq_msg_gets (&routing_id, "Peer-Address");
121 122
    assert (peer_address != 0);
    assert (streq (peer_address, "127.0.0.1"));
123

124
    //  Second frame is greeting signature
125
    rc = zmq_recv (stream, buffer, 255, 0);
126 127 128 129
    assert (rc == 10);
    assert (memcmp (buffer, greeting.signature, 10) == 0);

    //  Send our own protocol greeting
130
    rc = zmq_msg_send (&routing_id, stream, ZMQ_SNDMORE);
131 132 133 134 135
    assert (rc > 0);
    rc = zmq_send (stream, &greeting, sizeof (greeting), 0);
    assert (rc == sizeof (greeting));

    //  Now we expect the data from the DEALER socket
136
    //  We want the rest of greeting along with the Ready command
Pieter Hintjens's avatar
Pieter Hintjens committed
137 138
    int bytes_read = 0;
    while (bytes_read < 97) {
139 140
        //  First frame is the routing id of the connection (each time)
        rc = zmq_msg_recv (&routing_id, stream, 0);
141
        assert (rc > 0);
142
        assert (zmq_msg_more (&routing_id));
143
        //  Second frame contains the next chunk of data
Pieter Hintjens's avatar
Pieter Hintjens committed
144 145 146 147
        rc = zmq_recv (stream, buffer + bytes_read, 255 - bytes_read, 0);
        assert (rc >= 0);
        bytes_read += rc;
    }
148 149

    //  First two bytes are major and minor version numbers.
150 151
    assert (buffer[0] == 3); //  ZMTP/3.0
    assert (buffer[1] == 0);
152 153

    //  Mechanism is "NULL"
154 155
    assert (memcmp (buffer + 2, "NULL\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0", 20)
            == 0);
156
    assert (memcmp (buffer + 54, "\4\51\5READY", 8) == 0);
157 158
    assert (memcmp (buffer + 62, "\13Socket-Type\0\0\0\6DEALER", 22) == 0);
    assert (memcmp (buffer + 84, "\10Identity\0\0\0\0", 13) == 0);
159 160

    //  Announce we are ready
161
    memcpy (buffer, "\4\51\5READY", 8);
162
    memcpy (buffer + 8, "\13Socket-Type\0\0\0\6ROUTER", 22);
163
    memcpy (buffer + 30, "\10Identity\0\0\0\0", 13);
164 165

    //  Send Ready command
166
    rc = zmq_msg_send (&routing_id, stream, ZMQ_SNDMORE);
167
    assert (rc > 0);
168 169
    rc = zmq_send (stream, buffer, 43, 0);
    assert (rc == 43);
170 171

    //  Now we expect the data from the DEALER socket
172 173
    //  First frame is, again, the routing id of the connection
    rc = zmq_msg_recv (&routing_id, stream, 0);
174
    assert (rc > 0);
175
    assert (zmq_msg_more (&routing_id));
176 177 178 179 180 181

    //  Third frame contains Hello message from DEALER
    rc = zmq_recv (stream, buffer, sizeof buffer, 0);
    assert (rc == 7);

    //  Then we have a 5-byte message "Hello"
182 183
    assert (buffer[0] == 0); //  Flags = 0
    assert (buffer[1] == 5); //  Size = 5
184 185 186
    assert (memcmp (buffer + 2, "Hello", 5) == 0);

    //  Send "World" back to DEALER
187
    rc = zmq_msg_send (&routing_id, stream, ZMQ_SNDMORE);
188
    assert (rc > 0);
189
    byte world[] = {0, 5, 'W', 'o', 'r', 'l', 'd'};
190 191 192 193 194 195 196 197
    rc = zmq_send (stream, world, sizeof (world), 0);
    assert (rc == sizeof (world));

    //  Expect response on DEALER socket
    rc = zmq_recv (dealer, buffer, 255, 0);
    assert (rc == 5);
    assert (memcmp (buffer, "World", 5) == 0);

198
    //  Test large messages over STREAM socket
199 200
#define size 64000
    uint8_t msgout[size];
201 202 203
    memset (msgout, 0xAB, size);
    zmq_send (dealer, msgout, size, 0);

204
    uint8_t msgin[9 + size];
205 206 207
    memset (msgin, 0, 9 + size);
    bytes_read = 0;
    while (bytes_read < 9 + size) {
208
        //  Get routing id frame
209 210 211 212 213 214 215 216 217
        rc = zmq_recv (stream, buffer, 256, 0);
        assert (rc > 0);
        //  Get next chunk
        rc = zmq_recv (stream, msgin + bytes_read, 9 + size - bytes_read, 0);
        assert (rc > 0);
        bytes_read += rc;
    }
    int byte_nbr;
    for (byte_nbr = 0; byte_nbr < size; byte_nbr++) {
218
        if (msgin[9 + byte_nbr] != 0xAB)
219 220
            assert (false);
    }
221 222 223 224 225 226 227 228 229 230 231
    rc = zmq_close (dealer);
    assert (rc == 0);

    rc = zmq_close (stream);
    assert (rc == 0);

    rc = zmq_ctx_term (ctx);
    assert (rc == 0);
}


232
static void test_stream_to_stream (void)
233 234
{
    int rc;
235 236
    size_t len = MAX_SOCKET_STRING;
    char my_endpoint[MAX_SOCKET_STRING];
237 238 239
    //  Set-up our context and sockets
    void *ctx = zmq_ctx_new ();
    assert (ctx);
240

241 242
    void *server = zmq_socket (ctx, ZMQ_STREAM);
    assert (server);
243 244 245
    int enabled = 1;
    rc = zmq_setsockopt (server, ZMQ_STREAM_NOTIFY, &enabled, sizeof (enabled));
    assert (rc == 0);
246 247 248
    rc = zmq_bind (server, "tcp://127.0.0.1:*");
    assert (rc == 0);
    rc = zmq_getsockopt (server, ZMQ_LAST_ENDPOINT, my_endpoint, &len);
249 250 251 252
    assert (rc == 0);

    void *client = zmq_socket (ctx, ZMQ_STREAM);
    assert (client);
253 254
    rc = zmq_setsockopt (client, ZMQ_STREAM_NOTIFY, &enabled, sizeof (enabled));
    assert (rc == 0);
255
    rc = zmq_connect (client, my_endpoint);
256
    assert (rc == 0);
257
    uint8_t id[256];
258
    size_t id_size = 256;
259
    uint8_t buffer[256];
260

261
    //  Connecting sends a zero message
262
    //  Server: First frame is routing id, second frame is zero
263 264 265 266
    id_size = zmq_recv (server, id, 256, 0);
    assert (id_size > 0);
    rc = zmq_recv (server, buffer, 256, 0);
    assert (rc == 0);
267
    //  Client: First frame is routing id, second frame is zero
268 269 270 271 272
    id_size = zmq_recv (client, id, 256, 0);
    assert (id_size > 0);
    rc = zmq_recv (client, buffer, 256, 0);
    assert (rc == 0);

273
    //  Sent HTTP request on client socket
274
    //  Get server routing id
275
    rc = zmq_getsockopt (client, ZMQ_ROUTING_ID, id, &id_size);
276
    assert (rc == 0);
277
    //  First frame is server routing id
278 279 280 281 282
    rc = zmq_send (client, id, id_size, ZMQ_SNDMORE);
    assert (rc == (int) id_size);
    //  Second frame is HTTP GET request
    rc = zmq_send (client, "GET /\n\n", 7, 0);
    assert (rc == 7);
283

284 285 286 287
    //  Get HTTP request; ID frame and then request
    id_size = zmq_recv (server, id, 256, 0);
    assert (id_size > 0);
    rc = zmq_recv (server, buffer, 256, 0);
288
    assert (rc != -1);
289
    assert (memcmp (buffer, "GET /\n\n", 7) == 0);
290

291
    //  Send reply back to client
292 293 294 295
    char http_response[] = "HTTP/1.0 200 OK\r\n"
                           "Content-Type: text/plain\r\n"
                           "\r\n"
                           "Hello, World!";
296 297 298 299 300 301 302 303 304 305
    rc = zmq_send (server, id, id_size, ZMQ_SNDMORE);
    assert (rc != -1);
    rc = zmq_send (server, http_response, sizeof (http_response), ZMQ_SNDMORE);
    assert (rc != -1);

    //  Send zero to close connection to client
    rc = zmq_send (server, id, id_size, ZMQ_SNDMORE);
    assert (rc != -1);
    rc = zmq_send (server, NULL, 0, ZMQ_SNDMORE);
    assert (rc != -1);
306 307 308 309 310 311 312

    //  Get reply at client and check that it's complete
    id_size = zmq_recv (client, id, 256, 0);
    assert (id_size > 0);
    rc = zmq_recv (client, buffer, 256, 0);
    assert (rc == sizeof (http_response));
    assert (memcmp (buffer, http_response, sizeof (http_response)) == 0);
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328

    // //  Get disconnection notification
    // FIXME: why does this block? Bug in STREAM disconnect notification?
    // id_size = zmq_recv (client, id, 256, 0);
    // assert (id_size > 0);
    // rc = zmq_recv (client, buffer, 256, 0);
    // assert (rc == 0);

    rc = zmq_close (server);
    assert (rc == 0);

    rc = zmq_close (client);
    assert (rc == 0);

    rc = zmq_ctx_term (ctx);
    assert (rc == 0);
329 330 331 332
}

int main (void)
{
333
    setup_test_environment ();
334 335
    test_stream_to_dealer ();
    test_stream_to_stream ();
336
}