SerialDevice.h

/*
 * Copyright (C) 2007 Marc Boris Drner
 * Copyright (C) 2007 Laurentiu-Gheorghe Crisan
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * As a special exception, you may use this file as part of a free
 * software library without restriction. Specifically, if other files
 * instantiate templates or use macros or inline functions from this
 * file, or you compile this file and link it with other files to
 * produce an executable, this file does not by itself cause the
 * resulting executable to be covered by the GNU General Public
 * License. This exception does not however invalidate any other
 * reasons why the executable file might be covered by the GNU Library
 * General Public License.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

#ifndef PT_SYSTEM_SERIALDEVICE_H
#define PT_SYSTEM_SERIALDEVICE_H

#include <Pt/System/Api.h>
#include <Pt/System/IODevice.h>
#include <Pt/Types.h>

namespace Pt {

namespace System {

class PT_SYSTEM_API SerialDevice : public IODevice
{
   private:
        class SerialDeviceImpl* _impl;
        Pt::uint32_t _r0;

   public:
        enum BaudRate
        {
            BaudRate0       = 0,
            BaudRate50      = 50,
            BaudRate75      = 75,
            BaudRate110     = 110,
            BaudRate134     = 134,
            BaudRate150     = 150,
            BaudRate200     = 200,
            BaudRate300     = 300,
            BaudRate600     = 600,
            BaudRate1200    = 1200,
            BaudRate1800    = 1800,
            BaudRate2400    = 2400,
            BaudRate4800    = 4800,
            BaudRate9600    = 9600,
            BaudRate19200   = 19200,
            BaudRate38400   = 38400,
            BaudRate57600   = 57600,
            BaudRate115200  = 115200
            #ifdef B230400
            , BaudRate230400  = 230400
            #endif
        };

        enum Parity
        {
            ParityEven,
            ParityOdd,
            ParityNone
        };

        enum FlowControl
        {
            FlowControlHard,
            FlowControlSoft,
            FlowControlNone
        };

        enum StopBits
        {
            OneStopBit,
            One5StopBits,
            TwoStopBits
        };


        SerialDevice();

        SerialDevice(const std::string& file, std::ios::openmode mode);

        SerialDevice(const char* file, std::ios::openmode mode);

        virtual ~SerialDevice();

        void open(const std::string& file, std::ios::openmode mode);

        void open(const char* file, std::ios::openmode mode);

        void setBaudRate( unsigned rate );

        unsigned baudRate() const;

        void setCharSize( int size );

        int charSize() const;

        void setStopBits( StopBits bits );

        StopBits stopBits() const;

        void setParity( Parity parity );

        Parity parity() const;

        void setFlowControl( FlowControl flowControl );

        FlowControl flowControl() const;

        void setRts(bool on);
        
        void setDtr(bool on);

        void setBreak(bool on);     
        
        void sendBreak(int duration = 0);

        bool isCts() const;

        bool isDsr() const;

    protected:
        // inherit docs
        void onClose();

        // inherit docs
        void onSetTimeout(std::size_t timeout);

        // inherit docs
        std::size_t onBeginRead(EventLoop& loop, char* buffer, std::size_t n, bool& eof);

        // inherit docs
        std::size_t onEndRead(EventLoop& loop, char* buffer, std::size_t n, bool& eof);

        // inherit docs
        std::size_t onBeginWrite(EventLoop& loop, const char* buffer, std::size_t n);

        // inherit docs
        std::size_t onEndWrite(EventLoop& loop, const char* buffer, std::size_t n);

        // inherit docs
        std::size_t onRead(char* buffer, std::size_t count, bool& eof);

        // inherit docs
        std::size_t onWrite(const char* buffer, std::size_t count);

        // inherit docs
        void onSync() const;

        // inherit docs
        void onCancel();

        // inherit docs
        bool onRun();
};

} // namespace System

} // namespace Pt

#endif // PT_SYSTEM_SERIALDEVICE_H