Line data    Source code

       1             : 
       2             : /* Copyright (c) 2014, Daniel Nachbaur <danielnachbaur@gmail.com>
       3             :  *
       4             :  * This library is free software; you can redistribute it and/or modify it under
       5             :  * the terms of the GNU Lesser General Public License version 2.1 as published
       6             :  * by the Free Software Foundation.
       7             :  *
       8             :  * This library is distributed in the hope that it will be useful, but WITHOUT
       9             :  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
      10             :  * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
      11             :  * details.
      12             :  *
      13             :  * You should have received a copy of the GNU Lesser General Public License
      14             :  * along with this library; if not, write to the Free Software Foundation, Inc.,
      15             :  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
      16             :  */
      17             : 
      18             : #ifndef EQ_NOTIFIER_INTERFACE_H
      19             : #define EQ_NOTIFIER_INTERFACE_H
      20             : 
      21             : #include <eq/client/types.h>
      22             : 
      23             : namespace eq
      24             : {
      25             : 
      26             : /** A base class for notifying errors and events. */
      27         285 : class NotifierInterface
      28             : {
      29             : public:
      30          15 :     virtual ~NotifierInterface() {}
      31             : 
      32             :     /**
      33             :      * Send an error event to the application node.
      34             :      *
      35             :      * @param error the error code.
      36             :      * @version 1.7.2
      37             :      */
      38             :     virtual EventOCommand sendError( const uint32_t error ) = 0;
      39             : 
      40             :     /**
      41             :      * Process a received event.
      42             :      *
      43             :      * The task of this method is to update this object as necessary, and
      44             :      * transform the event into an config event to be send to the
      45             :      * application using Config::sendEvent().
      46             :      *
      47             :      * @param event the received event.
      48             :      * @return true when the event was handled, false if not.
      49             :      * @version 1.7.2
      50             :      */
      51             :     virtual bool processEvent( const Event& event ) = 0;
      52             : };
      53             : }
      54             : 
      55             : 
      56             : #endif // EQ_NOTIFIER_INTERFACE_H