libzmq
master
ZeroMQ C++ Core Engine (LIBZMQ)
Main Page
Classes
Files
File List
File Members
i_encoder.hpp
Go to the documentation of this file.
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
#ifndef __ZMQ_I_ENCODER_HPP_INCLUDED__
31
#define __ZMQ_I_ENCODER_HPP_INCLUDED__
32
33
#include "
stdint.hpp
"
34
35
namespace
zmq
36
{
37
38
// Forward declaration
39
class
msg_t;
40
41
// Interface to be implemented by message encoder.
42
43
struct
i_encoder
44
{
45
virtual
~i_encoder
() {}
46
47
// The function returns a batch of binary data. The data
48
// are filled to a supplied buffer. If no buffer is supplied (data_
49
// is NULL) encoder will provide buffer of its own.
50
// Function returns 0 when a new message is required.
51
virtual
size_t
encode
(
unsigned
char
**data_,
size_t
size
) = 0;
52
53
// Load a new message into encoder.
54
virtual
void
load_msg
(
msg_t
*msg_) = 0;
55
56
};
57
58
}
59
60
#endif
size
#define size
zmq::msg_t
Definition:
msg.hpp:55
stdint.hpp
zmq::i_encoder
Definition:
i_encoder.hpp:43
zmq::i_encoder::~i_encoder
virtual ~i_encoder()
Definition:
i_encoder.hpp:45
zmq::i_encoder::load_msg
virtual void load_msg(msg_t *msg_)=0
zmq::i_encoder::encode
virtual size_t encode(unsigned char **data_, size_t size)=0
zmq
Definition:
address.hpp:35
zeromq
libzmq
src
i_encoder.hpp
Generated by
1.8.11