SerialPort.h

Go to the documentation of this file.

// -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 4; tab-width: 4; -*-
// vim: set shiftwidth=4 softtabstop=4 expandtab:
/*
 ********************************************************************
 ** NIDAS: NCAR In-situ Data Acquistion Software
 **
 ** 2006, Copyright University Corporation for Atmospheric Research
 **
 ** This program is free software; you can redistribute it and/or modify
 ** it under the terms of the GNU General Public License as published by
 ** the Free Software Foundation; either version 2 of the License, or
 ** (at your option) any later version.
 **
 ** This program 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 General Public License for more details.
 **
 ** The LICENSE.txt file accompanying this software contains
 ** a copy of the GNU General Public License. If it is not found,
 ** write to the Free Software Foundation, Inc.,
 ** 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 **
 ********************************************************************
*/

#ifndef NIDAS_UTIL_SERIALPORT_H
#define NIDAS_UTIL_SERIALPORT_H

#include <unistd.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>

#include <string>
#include <iostream>

#include "Termios.h"
#include "IOException.h"

namespace nidas { namespace util {

class SerialPort
{

public:

    SerialPort();

    SerialPort(const SerialPort&);

    SerialPort(const std::string& name);

    SerialPort(const std::string& name, int fd) throw (IOException);

    virtual ~SerialPort();

    Termios& termios() { return _termios; }
    
    const Termios& getTermios() const { return _termios; }

    void applyTermios() throw(IOException);

    const std::string& getName() const { return _name; }

    void setName(const std::string& val) { _name = val; }

    virtual int open(int mode = O_RDONLY) throw (IOException);

    void close();

    // int &fd() { return _fd; }

    int getFd() const { return _fd; }

    int getModemStatus() throw (IOException);

    void setModemStatus(int val) throw (IOException);

    void clearModemBits(int val) throw (IOException);

    void setModemBits(int val) throw (IOException);

    bool getCarrierDetect() throw (IOException);

    static std::string modemFlagsToString(int modem);

    void setBlocking(bool val) throw(IOException);
    bool getBlocking() throw(IOException);

    void drain() throw(IOException);

    void flushInput() throw(IOException);

    void flushOutput() throw(IOException);

    void flushBoth() throw(IOException);

    int timeoutOrEOF() const { return _state == TIMEOUT_OR_EOF; }

    virtual int readUntil(char *buf,int len,char term) throw(IOException);

    virtual int readLine(char *buf,int len) throw(IOException);

    virtual int read(char *buf,int len) throw(IOException);

    virtual char readchar() throw(IOException);

    virtual int write(const void *buf,int len) throw(IOException);

    static int createPtyLink(const std::string& linkname) throw(IOException);

private:

    SerialPort& operator=(const SerialPort&);

    Termios _termios;

    int _fd;

    std::string _name;

    enum state { OK, TIMEOUT_OR_EOF} _state;

    char *_savep;

    char *_savebuf;

    int _savelen;

    int _savealloc;

    bool _blocking;
};

}}  // namespace nidas namespace util

#endif