IODevice.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_CORE_IODEVICE_H
#define NIDAS_CORE_IODEVICE_H

#include <nidas/util/InvalidParameterException.h>
#include <nidas/util/IOException.h>

#include <sys/ioctl.h>

namespace nidas { namespace core {

class IODevice
{
public:

    IODevice(): _devname() {}

    virtual ~IODevice() {}

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

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

    virtual void open(int flags)
        throw(nidas::util::IOException,nidas::util::InvalidParameterException) = 0;

    virtual int getReadFd() const = 0;

    virtual int getWriteFd() const = 0;

    virtual size_t read(void *buf, size_t len) throw(nidas::util::IOException) = 0; 

    virtual size_t read(void *buf, size_t len,int msecTimeout) throw(nidas::util::IOException) = 0; 

    virtual size_t getBytesAvailable() const throw(nidas::util::IOException)
    {
        int nbytes;
        int err = ::ioctl(getReadFd(),FIONREAD,&nbytes);
        if (err < 0)
            throw nidas::util::IOException(getName(),"ioctl FIONREAD",errno);
        return nbytes;
    }

    virtual size_t write(const void *buf, size_t len) throw(nidas::util::IOException) = 0;

    /*
     * Perform an ioctl on the device. request is an integer
     * value which must be supported by the device. Normally
     * this is a value from a header file for the device.
     */
    virtual void ioctl(int request, void* buf, size_t len)
        throw(nidas::util::IOException) = 0;

    virtual void close() throw(nidas::util::IOException) = 0;

    // bool reopenOnIOException() const { return false; }

private:

    std::string _devname;

    IODevice(const IODevice&);

    IODevice& operator=(const IODevice&);


};

}}  // namespace nidas namespace core

#endif