IOChannel.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
 **
 ** 2005, 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_IOCHANNEL_H
#define NIDAS_CORE_IOCHANNEL_H

#include "ConnectionInfo.h"

#include "Datagrams.h"
#include "DOMable.h"

#include "Sample.h"

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

#include <sys/uio.h>

#include <set>

namespace nidas { namespace core {

class DSMService;
class DSMConfig;
class IOChannel;

class IOChannelRequester
{
public:
    virtual ~IOChannelRequester() {}
    virtual IOChannelRequester* connected(IOChannel*) throw() = 0;
};

class IOChannel : public DOMable {

public:

    IOChannel();

    IOChannel(const IOChannel& x):DOMable(),_dsm(x._dsm),_conInfo() {}

    IOChannel& operator=(const IOChannel& rhs)
    {
        if (&rhs != this) {
            *(DOMable*) this = rhs;
            _dsm = rhs._dsm;
        }
        return *this;
    }

    virtual ~IOChannel() {}

    virtual IOChannel* clone() const = 0;

    virtual void setName(const std::string& val) = 0;

    virtual const std::string& getName() const = 0;

    /*
     * The requestType is used when establishing McSocket
     * connections and is ignored otherwise.
     */
    virtual void setRequestType(enum McSocketRequest) {}

    virtual enum McSocketRequest getRequestType() const { return (enum McSocketRequest)0; }

    virtual bool isNewInput() const { return false; }

    virtual void requestConnection(IOChannelRequester*)
        throw(nidas::util::IOException) = 0;

    virtual int getReconnectDelaySecs() const
    {
        return 10;
    }

    virtual void setNonBlocking(bool val)
        throw(nidas::util::IOException) = 0;

    virtual bool isNonBlocking() const
        throw(nidas::util::IOException) = 0;

    virtual IOChannel* connect()
        throw(nidas::util::IOException,nidas::util::UnknownHostException) = 0;

    virtual const ConnectionInfo& getConnectionInfo() const
    {
        return _conInfo;
    }

    virtual void setConnectionInfo(const ConnectionInfo& val)
    {
        _conInfo = val;
    }

    virtual size_t getBufferSize() const throw() { return 8192; }

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

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

    virtual size_t write(const struct iovec* iov, int iovcnt)
        throw(nidas::util::IOException) = 0;

    virtual void flush() throw(nidas::util::IOException) {}

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

    virtual int getFd() const = 0;

    static IOChannel* createIOChannel(const xercesc::DOMElement* node)
            throw(nidas::util::InvalidParameterException);

#ifdef DOXYGEN
    virtual dsm_time_t createFile(dsm_time_t t, bool exact)
        throw(nidas::util::IOException)
#else
    virtual dsm_time_t createFile(dsm_time_t, bool)
        throw(nidas::util::IOException)
#endif
    {
        return LONG_LONG_MAX;
    }

    virtual bool writeNidasHeader() const { return true; }

    virtual void setDSMConfig(const DSMConfig* val) 
    {
        _dsm = val;
    }

    virtual const DSMConfig* getDSMConfig() const 
    {
        return _dsm;
    }

private:
    
    const DSMConfig* _dsm;

    ConnectionInfo _conInfo;

};

}}  // namespace nidas namespace core

#endif