encoder.hpp 5.18 KB
Newer Older
Martin Sustrik's avatar
Martin Sustrik committed
1
/*
2
    Copyright (c) 2007-2010 iMatix Corporation
Martin Sustrik's avatar
Martin Sustrik committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

    This file is part of 0MQ.

    0MQ is free software; you can redistribute it and/or modify it under
    the terms of the Lesser GNU General Public License as published by
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.

    0MQ 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
    Lesser GNU General Public License for more details.

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

Martin Sustrik's avatar
Martin Sustrik committed
20 21
#ifndef __ZMQ_ENCODER_HPP_INCLUDED__
#define __ZMQ_ENCODER_HPP_INCLUDED__
Martin Sustrik's avatar
Martin Sustrik committed
22 23 24

#include <stddef.h>
#include <string.h>
25
#include <stdlib.h>
Martin Sustrik's avatar
Martin Sustrik committed
26 27
#include <algorithm>

28 29
#include "err.hpp"

Martin Sustrik's avatar
Martin Sustrik committed
30
namespace zmq
Martin Sustrik's avatar
Martin Sustrik committed
31 32 33 34 35 36 37 38 39 40
{

    //  Helper base class for encoders. It implements the state machine that
    //  fills the outgoing buffer. Derived classes should implement individual
    //  state machine actions.

    template <typename T> class encoder_t
    {
    public:

41 42
        inline encoder_t (size_t bufsize_) :
            bufsize (bufsize_)
Martin Sustrik's avatar
Martin Sustrik committed
43
        {
44 45
            buf = (unsigned char*) malloc (bufsize_);
            zmq_assert (buf);
Martin Sustrik's avatar
Martin Sustrik committed
46 47
        }

48 49 50 51 52
        inline ~encoder_t ()
        {
            free (buf);
        }

Martin Sustrik's avatar
Martin Sustrik committed
53 54 55 56 57 58 59
        //  The function returns a batch of binary data. The data
        //  are filled to a supplied buffer. If no buffer is supplied (data_
        //  points to NULL) decoder object will provide buffer of its own.
        //  If offset is not NULL, it is filled by offset of the first message
        //  in the batch.If there's no beginning of a message in the batch,
        //  offset is set to -1.
        inline void get_data (unsigned char **data_, size_t *size_,
Martin Sustrik's avatar
Martin Sustrik committed
60 61
            int *offset_ = NULL)
        {
Martin Sustrik's avatar
Martin Sustrik committed
62 63 64
            unsigned char *buffer = !*data_ ? buf : *data_;
            size_t buffersize = !*data_ ? bufsize : *size_;

Martin Sustrik's avatar
Martin Sustrik committed
65
            size_t pos = 0;
66 67 68 69 70 71 72 73 74 75
            if (offset_)
                *offset_ = -1;

            while (true) {

                //  If there are no more data to return, run the state machine.
                //  If there are still no data, return what we already have
                //  in the buffer.
                if (!to_write) {
                    if (!(static_cast <T*> (this)->*next) ()) {
Martin Sustrik's avatar
Martin Sustrik committed
76
                        *data_ = buffer;
77 78 79
                        *size_ = pos;
                        return;
                    }
Martin Sustrik's avatar
Martin Sustrik committed
80

81 82 83 84 85 86 87 88
                    //  If beginning of the message was processed, adjust the
                    //  first-message-offset.
                    if (beginning) { 
                        if (offset_ && *offset_ == -1)
                            *offset_ = pos;
                        beginning = false;
                    }
                }
89

90 91 92 93 94 95 96
                //  If there are no data in the buffer yet and we are able to
                //  fill whole buffer in a single go, let's use zero-copy.
                //  There's no disadvantage to it as we cannot stuck multiple
                //  messages into the buffer anyway. Note that subsequent
                //  write(s) are non-blocking, thus each single write writes
                //  at most SO_SNDBUF bytes at once not depending on how large
                //  is the chunk returned from here.
97 98 99
                //  As a consequence, large messages being sent won't block
                //  other engines running in the same I/O thread for excessive
                //  amounts of time.
Martin Sustrik's avatar
Martin Sustrik committed
100
                if (!pos && !*data_ && to_write >= buffersize) {
101
                    *data_ = write_pos;
102 103
                    *size_ = to_write;
                    write_pos = NULL;
104
                    to_write = 0;
105
                    return;
106 107
                }

108
                //  Copy data to the buffer. If the buffer is full, return.
Martin Sustrik's avatar
Martin Sustrik committed
109 110
                size_t to_copy = std::min (to_write, buffersize - pos);
                memcpy (buffer + pos, write_pos, to_copy);
111 112 113
                pos += to_copy;
                write_pos += to_copy;
                to_write -= to_copy;
Martin Sustrik's avatar
Martin Sustrik committed
114 115
                if (pos == buffersize) {
                    *data_ = buffer;
116 117
                    *size_ = pos;
                    return;
Martin Sustrik's avatar
Martin Sustrik committed
118 119 120
                }
            }
        }
121

Martin Sustrik's avatar
Martin Sustrik committed
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
    protected:

        //  Prototype of state machine action.
        typedef bool (T::*step_t) ();

        //  This function should be called from derived class to write the data
        //  to the buffer and schedule next state machine action. Set beginning
        //  to true when you are writing first byte of a message.
        inline void next_step (void *write_pos_, size_t to_write_,
            step_t next_, bool beginning_)
        {
            write_pos = (unsigned char*) write_pos_;
            to_write = to_write_;
            next = next_;
            beginning = beginning_;
        }

    private:

        unsigned char *write_pos;
        size_t to_write;
        step_t next;
        bool beginning;

146 147 148
        size_t bufsize;
        unsigned char *buf;

Martin Sustrik's avatar
Martin Sustrik committed
149 150 151 152 153 154 155
        encoder_t (const encoder_t&);
        void operator = (const encoder_t&);
    };

}

#endif