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_ENGINE_HPP_INCLUDED__
      31             : #define __ZMQ_I_ENGINE_HPP_INCLUDED__
      32             : 
      33             : namespace zmq
      34             : {
      35             : 
      36             :     class io_thread_t;
      37             : 
      38             :     //  Abstract interface to be implemented by various engines.
      39             : 
      40        6768 :     struct i_engine
      41             :     {
      42        6768 :         virtual ~i_engine () {}
      43             : 
      44             :         //  Plug the engine to the session.
      45             :         virtual void plug (zmq::io_thread_t *io_thread_,
      46             :             class session_base_t *session_) = 0;
      47             : 
      48             :         //  Terminate and deallocate the engine. Note that 'detached'
      49             :         //  events are not fired on termination.
      50             :         virtual void terminate () = 0;
      51             : 
      52             :         //  This method is called by the session to signalise that more
      53             :         //  messages can be written to the pipe.
      54             :         virtual void restart_input () = 0;
      55             : 
      56             :         //  This method is called by the session to signalise that there
      57             :         //  are messages to send available.
      58             :         virtual void restart_output () = 0;
      59             : 
      60             :         virtual void zap_msg_available () = 0;
      61             :     };
      62             : 
      63             : }
      64             : 
      65             : #endif