Line data    Source code

       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_DECODER_HPP_INCLUDED__
      31             : #define __ZMQ_I_DECODER_HPP_INCLUDED__
      32             : 
      33             : #include "stdint.hpp"
      34             : 
      35             : namespace zmq
      36             : {
      37             : 
      38             :     class msg_t;
      39             : 
      40             :     //  Interface to be implemented by message decoder.
      41             : 
      42        4356 :     class i_decoder
      43             :     {
      44             :     public:
      45        4356 :         virtual ~i_decoder () {}
      46             : 
      47             :         virtual void get_buffer (unsigned char **data_, size_t *size_) = 0;
      48             : 
      49             :         virtual void resize_buffer(size_t) = 0;
      50             :         //  Decodes data pointed to by data_.
      51             :         //  When a message is decoded, 1 is returned.
      52             :         //  When the decoder needs more data, 0 is returned.
      53             :         //  On error, -1 is returned and errno is set accordingly.
      54             :         virtual int decode (const unsigned char *data_, size_t size_,
      55             :                             size_t &processed) = 0;
      56             : 
      57             :         virtual msg_t *msg () = 0;
      58             : 
      59             : 
      60             :     };
      61             : 
      62             : }
      63             : 
      64             : #endif