2013-03-12 15:26:07 +01:00
|
|
|
/*
|
2015-01-22 10:32:06 +01:00
|
|
|
Copyright (c) 2007-2015 Contributors as noted in the AUTHORS file
|
2013-03-12 15:26:07 +01:00
|
|
|
|
2015-06-02 22:33:55 +02:00
|
|
|
This file is part of libzmq, the ZeroMQ core engine in C++.
|
2013-03-12 15:26:07 +01:00
|
|
|
|
2015-06-02 22:33:55 +02:00
|
|
|
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
|
2013-03-12 15:26:07 +01:00
|
|
|
(at your option) any later version.
|
|
|
|
|
2015-06-02 22:33:55 +02:00
|
|
|
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.
|
2013-03-12 15:26:07 +01:00
|
|
|
|
|
|
|
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/>.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef __ZMQ_V2_DECODER_HPP_INCLUDED__
|
|
|
|
#define __ZMQ_V2_DECODER_HPP_INCLUDED__
|
|
|
|
|
|
|
|
#include "decoder.hpp"
|
|
|
|
|
|
|
|
namespace zmq
|
|
|
|
{
|
2015-05-29 23:54:43 +02:00
|
|
|
// This allocater allocates a reference counted buffer which is used by v2_decoder_t
|
|
|
|
// to use zero-copy msg::init_data to create messages with memory from this buffer as
|
|
|
|
// data storage.
|
|
|
|
//
|
|
|
|
// The buffer is allocated with a reference count of 1 to make sure that is is alive while
|
|
|
|
// decoding messages. Otherwise, it is possible that e.g. the first message increases the count
|
|
|
|
// from zero to one, gets passed to the user application, processed in the user thread and deleted
|
|
|
|
// which would then deallocate the buffer. The drawback is that the buffer may be allocated longer
|
|
|
|
// than necessary because it is only deleted when allocate is called the next time.
|
|
|
|
class shared_message_memory_allocator
|
2013-03-12 15:26:07 +01:00
|
|
|
{
|
|
|
|
public:
|
2015-05-29 23:54:43 +02:00
|
|
|
shared_message_memory_allocator(size_t bufsize_);
|
|
|
|
|
|
|
|
~shared_message_memory_allocator();
|
|
|
|
|
|
|
|
// Allocate a new buffer
|
|
|
|
//
|
|
|
|
// This releases the current buffer to be bound to the lifetime of the messages
|
|
|
|
// created on this bufer.
|
|
|
|
unsigned char* allocate();
|
|
|
|
|
|
|
|
// force deallocation of buffer.
|
|
|
|
void deallocate();
|
|
|
|
|
|
|
|
// Give up ownership of the buffer. The buffer's lifetime is now coupled to
|
|
|
|
// the messages constructed on top of it.
|
|
|
|
unsigned char* release();
|
|
|
|
|
|
|
|
void inc_ref();
|
|
|
|
|
|
|
|
static void call_dec_ref(void*, void* buffer);
|
|
|
|
|
|
|
|
size_t size() const;
|
2013-03-12 15:26:07 +01:00
|
|
|
|
2015-05-29 23:54:43 +02:00
|
|
|
// Return pointer to the first message data byte.
|
|
|
|
unsigned char* data();
|
|
|
|
|
|
|
|
// Return pointer to the first byte of the buffer.
|
|
|
|
unsigned char* buffer()
|
|
|
|
{
|
|
|
|
return buf;
|
|
|
|
}
|
|
|
|
|
2015-06-10 22:09:55 +02:00
|
|
|
void resize(size_t new_size)
|
|
|
|
{
|
|
|
|
bufsize = new_size;
|
|
|
|
}
|
|
|
|
|
2015-06-13 17:30:36 +02:00
|
|
|
//
|
|
|
|
zmq::atomic_counter_t* create_refcnt()
|
|
|
|
{
|
|
|
|
return msg_refcnt++;
|
|
|
|
}
|
|
|
|
|
2015-05-29 23:54:43 +02:00
|
|
|
private:
|
|
|
|
unsigned char* buf;
|
|
|
|
size_t bufsize;
|
2015-06-13 22:07:54 +02:00
|
|
|
size_t max_size;
|
2015-06-10 22:09:55 +02:00
|
|
|
zmq::atomic_counter_t* msg_refcnt;
|
2015-05-29 23:54:43 +02:00
|
|
|
};
|
|
|
|
|
|
|
|
// Decoder for ZMTP/2.x framing protocol. Converts data stream into messages.
|
|
|
|
// The class has to inherit from shared_message_memory_allocator because
|
|
|
|
// the base class calls allocate in its constructor.
|
|
|
|
class v2_decoder_t :
|
|
|
|
// inherit first from allocator to ensure that it is constructed before decoder_base_t
|
|
|
|
public shared_message_memory_allocator,
|
|
|
|
public decoder_base_t <v2_decoder_t, shared_message_memory_allocator>
|
|
|
|
{
|
|
|
|
public:
|
2013-03-18 02:00:00 +01:00
|
|
|
v2_decoder_t (size_t bufsize_, int64_t maxmsgsize_);
|
2013-03-12 15:26:07 +01:00
|
|
|
virtual ~v2_decoder_t ();
|
|
|
|
|
|
|
|
// i_decoder interface.
|
2013-03-18 02:00:00 +01:00
|
|
|
virtual msg_t *msg () { return &in_progress; }
|
2013-03-12 15:26:07 +01:00
|
|
|
|
|
|
|
private:
|
|
|
|
|
2015-05-29 23:54:43 +02:00
|
|
|
int flags_ready (unsigned char const*);
|
|
|
|
int one_byte_size_ready (unsigned char const*);
|
|
|
|
int eight_byte_size_ready (unsigned char const*);
|
|
|
|
int message_ready (unsigned char const*);
|
|
|
|
|
|
|
|
int size_ready(uint64_t size_, unsigned char const*);
|
2013-03-12 15:26:07 +01:00
|
|
|
|
|
|
|
unsigned char tmpbuf [8];
|
|
|
|
unsigned char msg_flags;
|
|
|
|
msg_t in_progress;
|
|
|
|
|
|
|
|
const int64_t maxmsgsize;
|
|
|
|
|
|
|
|
v2_decoder_t (const v2_decoder_t&);
|
|
|
|
void operator = (const v2_decoder_t&);
|
|
|
|
};
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
#endif
|