serialport.h

Go to the documentation of this file.

/* Flexiport
 *
 * Header file for the serial port class.
 *
 * Copyright 2008-2011 Geoffrey Biggs geoffrey.biggs@aist.go.jp
 *     RT-Synthesis Research Group
 *     Intelligent Systems Research Institute,
 *     National Institute of Advanced Industrial Science and Technology (AIST),
 *     Japan
 *     All rights reserved.
 *
 * This file is part of Flexiport.
 *
 * Flexiport 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.
 *
 * Flexiport 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 Flexiport. If not, see
 * <http://www.gnu.org/licenses/>.
 */

#ifndef __SERIALPORT_H
#define __SERIALPORT_H

#include <flexiport/port.h>

#include <map>
#include <string>
#if defined (WIN32)
    #include <Windows.h>
#endif

namespace flexiport
{

class FLEXIPORT_EXPORT SerialPort : public Port
{
    public:
        SerialPort (std::map<std::string, std::string> options);
        ~SerialPort ();

        void Open ();
        void Close ();
        ssize_t Read (void * const buffer, size_t count);
        ssize_t ReadFull (void * const buffer, size_t count);
        ssize_t BytesAvailable ();
        ssize_t BytesAvailableWait ();
        ssize_t Write (const void * const buffer, size_t count);
        void Flush ();
        void Drain ();
        std::string GetStatus () const;
        void SetTimeout (Timeout timeout);
        void SetCanRead (bool canRead);
        void SetCanWrite (bool canWrite);
        bool IsOpen () const                        { return _open; }

        void SetBaudRate (unsigned int baud);
        unsigned int GetBaudRate () const           { return _baud; }

    private:
#if defined (WIN32)
        HANDLE _fd;             // Serial device handle
#else
        int _fd;                // Serial device file descriptor
#endif

        std::string _device;
        unsigned int _baud;
        unsigned int _dataBits;
        unsigned int _stopBits;
        typedef enum {PAR_NONE, PAR_EVEN, PAR_ODD} Parity;
        Parity _parity;
        bool _hwFlowCtrl;
        bool _open;

        void CheckPort (bool read);
        bool ProcessOption (const std::string &option, const std::string &value);

        bool IsDataAvailable ();
#if !defined (WIN32)
        typedef enum {TIMED_OUT, DATA_AVAILABLE, CAN_WRITE} WaitStatus;
        WaitStatus WaitForDataOrTimeout ();
        WaitStatus WaitForWritableOrTimeout ();
#endif
        void SetPortSettings ();
        void SetPortTimeout ();
};

} // namespace flexiport

#endif // __SERIALPORT_H