ICommunication.h

Go to the documentation of this file.

#pragma once
 
#include <cstddef>
 
class ICommunication {
protected:
  bool m_connected;
 
public:
  /*
     * important to declare this, or otherwise pointer to base class could
     * potentially lead to undefined behavior, if we do not declare the
     * destructor as virtual
     */
  virtual ~ICommunication() {}
 
  /*
     * Code that is used to prepare the communication
     * like setting baud rate, selecting a proper
     * port etc. is happening in the initialization
     */
  virtual void VInitialize(){};
 
  /*
     * Establish connection with peer
     * using the current communication protocol
     */
  virtual void VConnect() = 0;
 
  /*
     * Stops the communication with the current
     * communication protocol and clears
     * the used buffers
     */
  virtual void VDisconnect() = 0;
 
  /*
     * Transfer the given data using the
     * current communication protocol
     */
  virtual size_t VSendData(void*, const size_t) = 0;
 
  /*
     * Reads from the device and provides the data read
     */
  virtual size_t VReceiveData(void*, const size_t) = 0;
 
  /*
     * Returns true when the current communication
     * has been established successfully
     */
  bool IsConnected() const {
    return m_connected;
  }
};
/*vim:set et sw=2 ts=2 tw=80:*/