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 #include "precompiled.hpp"
31 #include "encoder.hpp"
32 #include "v1_encoder.hpp"
33 #include "msg.hpp"
34 #include "wire.hpp"
35 
36 #include <limits.h>
37 
v1_encoder_t(size_t bufsize_)38 zmq::v1_encoder_t::v1_encoder_t (size_t bufsize_) :
39     encoder_base_t<v1_encoder_t> (bufsize_)
40 {
41     //  Write 0 bytes to the batch and go to message_ready state.
42     next_step (NULL, 0, &v1_encoder_t::message_ready, true);
43 }
44 
~v1_encoder_t()45 zmq::v1_encoder_t::~v1_encoder_t ()
46 {
47 }
48 
size_ready()49 void zmq::v1_encoder_t::size_ready ()
50 {
51     //  Write message body into the buffer.
52     next_step (in_progress ()->data (), in_progress ()->size (),
53                &v1_encoder_t::message_ready, true);
54 }
55 
message_ready()56 void zmq::v1_encoder_t::message_ready ()
57 {
58     size_t header_size = 2; // flags byte + size byte
59     //  Get the message size.
60     size_t size = in_progress ()->size ();
61 
62     //  Account for the 'flags' byte.
63     size++;
64 
65     //  Account for the subscribe/cancel byte.
66     if (in_progress ()->is_subscribe () || in_progress ()->is_cancel ())
67         size++;
68 
69     //  For messages less than 255 bytes long, write one byte of message size.
70     //  For longer messages write 0xff escape character followed by 8-byte
71     //  message size. In both cases 'flags' field follows.
72     if (size < UCHAR_MAX) {
73         _tmpbuf[0] = static_cast<unsigned char> (size);
74         _tmpbuf[1] = (in_progress ()->flags () & msg_t::more);
75     } else {
76         _tmpbuf[0] = UCHAR_MAX;
77         put_uint64 (_tmpbuf + 1, size);
78         _tmpbuf[9] = (in_progress ()->flags () & msg_t::more);
79         header_size = 10;
80     }
81 
82     //  Encode the subscribe/cancel byte. This is done in the encoder as
83     //  opposed to when the subscribe message is created to allow different
84     //  protocol behaviour on the wire in the v3.1 and legacy encoders.
85     //  It results in the work being done multiple times in case the sub
86     //  is sending the subscription/cancel to multiple pubs, but it cannot
87     //  be avoided. This processing can be moved to xsub once support for
88     //  ZMTP < 3.1 is dropped.
89     if (in_progress ()->is_subscribe ())
90         _tmpbuf[header_size++] = 1;
91     else if (in_progress ()->is_cancel ())
92         _tmpbuf[header_size++] = 0;
93 
94     next_step (_tmpbuf, header_size, &v1_encoder_t::size_ready, false);
95 }
96