spaclient.h

/*
   SpaIot Library (c) by epsilonrt - epsilonrt@epsilonrt.fr
   This file is part of SpaIot library <https://github.com/epsilonrt/spaiot-lib>
 
   SpaIot library is licensed under a
   Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
 
   You should have received a copy of the license along with this
   work. If not, see <http://creativecommons.org/licenses/by-nc-sa/4.0/>.
 
   SpaIot library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY;
*/
#pragma once
 
#include <set>
#include <initializer_list>
#include "event.h"
 
namespace SpaIot {
 
  class SpaClient {
    public:
 
      SpaClient();
 
      virtual ~SpaClient();
 
      SpaClient (std::initializer_list<Event::Type> subscribedEvents);
 
      SpaClient (const std::set<Event::Type> &subscribedEvents);
 
      SpaClient (const SpaClient &other);
 
      SpaClient (SpaClient &&other);
 
      SpaClient &operator= (const SpaClient &other);
 
      SpaClient &operator= (SpaClient &&other);
 
      virtual void clear();
 
      bool isNull() const;
 
      virtual bool isEmpty() const;
 
      virtual bool operator== (const SpaClient &other) const;
 
      virtual bool operator!= (const SpaClient &other) const;
 
      void subscribe (std::initializer_list<Event::Type> subscribedEvents);
 
      void subscribe (std::set<Event::Type> subscribedEvents);
 
      void subscribe (Event::Type event);
 
      const std::set<Event::Type> &subscribedEvents() const;
 
      bool isSubscribed (const Event::Type &event) const;
 
      bool write (const Event &event);
 
      Event read ();
 
      Event read (Event::Type type);
 
      int available() const;
 
      bool begin();
 
      virtual bool isOpen() const;
 
      virtual void end();
 
      virtual bool handle();
 
      virtual const String &className() const;
 
    protected:
      SpaClient (const char *className);
 
      void pushToSpa (const Event &event);
 
      bool pullFromSpa (Event &event);
 
      virtual bool pollSpaEvents ();
 
      uint16_t spaValue (Event::Type type) const;
    protected:
      class Private;
      SpaClient (Private &dd);
      std::unique_ptr<Private> d_ptr;
    private:
      PIMPL_DECLARE_PRIVATE (SpaClient)
  };
}