SerialPort.h

 
#ifndef MFRAME_6C0D897F_A9B6_4BE3_B3C0_796AF2C77F10
#define MFRAME_6C0D897F_A9B6_4BE3_B3C0_796AF2C77F10
 
/* ***************************************************************************************
 * Include
 */
 
//----------------------------------------------------------------------------------------
#include "./../../hal/serial/UART.h"
#include "./../io/Closeable.h"
#include "./../io/SimpleInputStream.h"
#include "./../io/SimpleOutputStream.h"
#include "./../lang/Object.h"
 
//----------------------------------------------------------------------------------------
 
/* ***************************************************************************************
 * Namespace
 */
namespace ufm::io {
  class SerialPort;
}  // namespace ufm::io
 
/* ***************************************************************************************
 * Class/Interface/Struct/Enum
 */
 
class ufm::io::SerialPort : public ufm::lang::Object, public ufm::io::Closeable {
  /* *************************************************************************************
   * Class
   */
 public:
  class InputStream : public ufm::io::SimpleInputStream,
                      public hal::serial::UART::EventReceiver {
    /* ***********************************************************************************
     * Variable
     */
 
   private:
    hal::serial::UART& vBase;
 
    /* ***********************************************************************************
     * Abstract Method
     */
 
    /* ***********************************************************************************
     * Construct Method
     */
   public:
    InputStream(hal::serial::UART& base);
 
    virtual ~InputStream(void) override;
 
    /* ***********************************************************************************
     * Operator Method
     */
 
    /* ***********************************************************************************
     * Override - ufm::io::SimpleInputStream
     */
   public:
    virtual bool abortRead(void) override;
 
    virtual bool read(ufm::lang::Appendable&           appendable,
                      void*                            attachment,
                      ufm::io::CompletionHandler<int>* handler) override;
 
    /* ***********************************************************************************
     * Override - hal::serial::UARTEventReceiver
     */
   public:
    virtual bool onReceiver(const uint8 data) override;
 
    /* ***********************************************************************************
     * Public Method
     */
 
    /* ***********************************************************************************
     * Protected Method
     */
 
    /* ***********************************************************************************
     * Private Method
     */
 
    /* ***********************************************************************************
     * Static Variable
     */
 
    /* ***********************************************************************************
     * Static Method
     */
  };
 
  /* *************************************************************************************
   * Class
   */
 public:
  class OutputStream : public ufm::io::SimpleOutputStream,
                       public hal::serial::UART::EventTransfer {
    /* ***********************************************************************************
     * Variable
     */
   private:
    hal::serial::UART& vBase;
 
    /* ***********************************************************************************
     * Abstract Method
     */
 
    /* ***********************************************************************************
     * Construct Method
     */
   public:
    OutputStream(hal::serial::UART& base);
 
    virtual ~OutputStream(void) override;
 
    /* ***********************************************************************************
     * Operator Method
     */
 
    /* ***********************************************************************************
     * Override - ufm::io::OutputStream
     */
   public:
    virtual bool abortWrite(void) override;
 
    virtual bool write(ufm::lang::Readable&             readable,
                       void*                            attachment,
                       ufm::io::CompletionHandler<int>* handler) override;
 
    /* ***********************************************************************************
     * Override - hal::serial::UARTEventTransfer
     */
   public:
    virtual bool onTransfer(uint8& data) override;
 
    /* ***********************************************************************************
     * Public Method
     */
 
    /* ***********************************************************************************
     * Protected Method
     */
 
    /* ***********************************************************************************
     * Private Method
     */
 
    /* ***********************************************************************************
     * Static Variable
     */
 
    /* ***********************************************************************************
     * Static Method
     */
  };
 
  /* *************************************************************************************
   * Variable
   */
 
 private:
  hal::serial::UART&                vBase;
  ufm::io::SerialPort::InputStream  vInputStream;
  ufm::io::SerialPort::OutputStream vOutputStream;
 
  /* *************************************************************************************
   * Abstract Method
   */
 
  /* *************************************************************************************
   * Construct Method
   */
 public:
  SerialPort(hal::serial::UART& base);
 
  virtual ~SerialPort(void) override;
 
  /* *************************************************************************************
   * Operator Method
   */
 
  operator ufm::io::InputStream&() {
    return this->vInputStream;
  }
 
  operator ufm::io::OutputStream&() {
    return this->vOutputStream;
  }
 
  /* *************************************************************************************
   * Override Method - ufm::lang::Closeable
   */
 public:
  virtual void close(void) override;
 
  virtual bool isOpen(void) override;
 
  /* *************************************************************************************
   * Public Method
   */
 public:
  virtual bool open(void);
 
  virtual uint32 setBaudrate(uint32 baudrate);
 
  virtual uint32 getBaudrate(void);
 
  virtual ufm::io::OutputStream& getOutputStream(void);
 
  virtual ufm::io::InputStream& getInputStream(void);
 
  /* *************************************************************************************
   * Protected Method
   */
 
  /* *************************************************************************************
   * Private Method
   */
 
  /* *************************************************************************************
   * Static Variable
   */
 
  /* *************************************************************************************
   * Static Method
   */
};
 
/* ***************************************************************************************
 * End of file
 */
 
#endif /* MFRAME_6C0D897F_A9B6_4BE3_B3C0_796AF2C77F10 */