-
Notifications
You must be signed in to change notification settings - Fork 3.7k
/
base.h
76 lines (60 loc) · 2.84 KB
/
base.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
/* Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License, version 2.0,
as published by the Free Software Foundation.
This program is also distributed with certain software (including
but not limited to OpenSSL) that is licensed under separate terms,
as designated in a particular file or component or in included license
documentation. The authors of MySQL hereby grant you an additional
permission to link the program and your derivative works with the
separately licensed software that they have included with MySQL.
This program 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 General Public License, version 2.0, for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
#ifndef CODECS_BASE_INCLUDED
#define CODECS_BASE_INCLUDED
#include <utility>
#include "libbinlogevents/include/binary_log.h"
namespace binary_log {
namespace codecs {
/**
This is the abstract and base class for binary log codecs.
It defines the codec API. Implementations of this class must
be stateless.
*/
class Codec {
public:
/**
Member function that shall decode the contents of the given buffer into a
binary log event.
@param from the buffer containing the encoded event.
@param size the length of the data in the buffer.
@param to the binary log event to populate.
@return a pair containing the amount of bytes decoded from the buffer and a
boolean stating whether there was an error or not. False if no
error, true otherwise.
*/
virtual std::pair<std::size_t, bool> decode(const unsigned char *from,
std::size_t size,
Binary_log_event &to) const = 0;
/**
Member function that shall encode the contents of the given binary log event
into an in memory buffer.
@param from the binary log event to encode.
@param to the buffer where the encoded event should be saved into.
@param size the size of the buffer.
@return a pair containing the amount of bytes encoded and whether there was
an error or not. False if no error, true otherwise.
*/
virtual std::pair<std::size_t, bool> encode(const Binary_log_event &from,
unsigned char *to,
std::size_t size) const = 0;
virtual ~Codec() {}
};
} // namespace codecs
} // namespace binary_log
#endif