summaryrefslogtreecommitdiff
path: root/cpp/src/qpid/sys/Codec.h
blob: e398403e476e05faafd5ca03c5d0ebff111fd0ba (plain)
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
#ifndef QPID_SYS_CODEC_H
#define QPID_SYS_CODEC_H

/*
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 */
#include <cstddef>

namespace qpid {
namespace sys {

/**
 * Generic codec interface
 */
class Codec
{
  public:
    virtual ~Codec() {}

    /** Decode from buffer, return number of bytes decoded.
     * @return may be less than size if there was incomplete
     * data at the end of the buffer.
     */
    virtual std::size_t decode(const char* buffer, std::size_t size) = 0;


    /** Encode into buffer, return number of bytes encoded */
    virtual std::size_t encode(char* buffer, std::size_t size) = 0;

    /** Return true if we have data to encode */
    virtual bool canEncode() = 0;
};
}} // namespace qpid::sys

#endif  /*!QPID_SYS_CODEC_H*/