i_encoder.hpp

Go to the documentation of this file.

/* SPDX-License-Identifier: MPL-2.0 */
 
#ifndef __ZMQ_I_ENCODER_HPP_INCLUDED__
#define __ZMQ_I_ENCODER_HPP_INCLUDED__
 
#include "macros.hpp"
#include "stdint.hpp"
 
namespace zmq
{
//  Forward declaration
class msg_t;
 
//  Interface to be implemented by message encoder.
 
struct i_encoder
{
    virtual ~i_encoder () ZMQ_DEFAULT;
 
    //  The function returns a batch of binary data. The data
    //  are filled to a supplied buffer. If no buffer is supplied (data_
    //  is NULL) encoder will provide buffer of its own.
    //  Function returns 0 when a new message is required.
    virtual size_t encode (unsigned char **data_, size_t size_) = 0;
 
    //  Load a new message into encoder.
    virtual void load_msg (msg_t *msg_) = 0;
};
}
 
#endif