Socket.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_SOCKET_H
#define NIDAS_CORE_SOCKET_H
 
#include "IOChannel.h"
#include "DOMable.h"
#include <nidas/util/Socket.h>
#include <nidas/util/Thread.h>
#include <nidas/util/UTime.h>
#include <nidas/util/auto_ptr.h>
 
#include <string>
#include <iostream>
 
namespace nidas { namespace core {
 
class Socket: public IOChannel {
 
public:
 
    Socket();
 
    Socket(nidas::util::Socket* sock);
 
    ~Socket();
 
    Socket* clone() const;
 
    void requestConnection(IOChannelRequester* service);
 
    IOChannel* connect();
 
    virtual bool isNewInput() const { return _newInput; }
 
    /*
     * The requestType is set when a socket connection has been
     * established with McSocket.
     */
    void setRequestType(enum McSocketRequest val)
    {
        _requestType = val;
    }
 
    enum McSocketRequest getRequestType() const
    {
        return _requestType;
    }
 
    void setKeepAliveIdleSecs(int val)
    {
        _keepAliveIdleSecs = val;
        if (_nusocket) _nusocket->setKeepAliveIdleSecs(val);
    }
 
    int getKeepAliveIdleSecs() const
    {
        if (_nusocket) return _nusocket->getKeepAliveIdleSecs();
        return _keepAliveIdleSecs;
    }
 
    std::list<nidas::util::Inet4NetworkInterface> getInterfaces() const
    {
        if (_nusocket) return _nusocket->getInterfaces();
        return std::list<nidas::util::Inet4NetworkInterface>();
    }
 
    void setNonBlocking(bool val)
    {
        _nonBlocking = val;
        if (_nusocket) _nusocket->setNonBlocking(val);
    }
 
    bool isNonBlocking() const
    {
        if (_nusocket) return _nusocket->isNonBlocking();
        return _nonBlocking;
    }
 
    size_t getBufferSize() const throw();
 
    size_t read(void* buf, size_t len)
    {
        if (_firstRead) _firstRead = false;
        else _newInput = false;
        return _nusocket->recv(buf,len);
    }
 
    size_t write(const void* buf, size_t len)
    {
    // std::cerr << "nidas::core::Socket::write, len=" << len << std::endl;
#ifdef DEBUG
    std::cerr << "writing, now=" << nidas::util::UTime().format(true,"%H%M%S.%3f") << " len=" << len << std::endl;
#endif
    return _nusocket->send(buf,len, MSG_NOSIGNAL);
    }
 
    size_t write(const struct iovec* iov, int iovcnt)
    {
        // std::cerr << "nidas::core::Socket::write, len=" << len << std::endl;
#ifdef DEBUG
        size_t l = 0;
        for (int i =0; i < iovcnt; i++) l += iov[i].iov_len;
        std::cerr << "writing, len=" << l << std::endl;
#endif
        return _nusocket->send(iov,iovcnt, MSG_NOSIGNAL);
    }
 
    void close();
 
    int getFd() const
    {
        if (_nusocket) return _nusocket->getFd();
        return -1;
    }
 
    const std::string& getName() const { return _name; }
 
    void setName(const std::string& val) { _name = val; }
 
    nidas::util::Inet4Address getRemoteInet4Address();
 
    void setRemoteHostPort(const std::string& host,unsigned short port);
 
    const std::string& getRemoteHost() const
    {
        return _remoteHost;
    }
 
    unsigned short getRemotePort() const
    {
        return _remotePort;
    }
 
    const std::string& getRemoteUnixPath() const
    {
        return _unixPath;
    }
 
    void setRemoteUnixPath(const std::string& unixPath);
 
    void setRemoteSocketAddress(const nidas::util::SocketAddress& val);
 
    const nidas::util::SocketAddress& getRemoteSocketAddress();
 
    static IOChannel* createSocket(const xercesc::DOMElement*);
 
    void fromDOMElement(const xercesc::DOMElement*);
 
    class ConnectionThread: public nidas::util::Thread
    {
    public:
        ConnectionThread(Socket* sock);
        ~ConnectionThread();
 
        int run();
 
        void interrupt();
 
    private:
        Socket* _socket;
        ConnectionThread(const ConnectionThread&);
        ConnectionThread& operator=(const ConnectionThread&);
    };
 
protected:
    Socket(const Socket& x);
 
private:
 
    nidas::util::auto_ptr<nidas::util::SocketAddress> _remoteSockAddr;
 
    std::string _remoteHost;
 
    unsigned short _remotePort;
 
    std::string _unixPath;
 
    nidas::util::Socket* _nusocket;
 
    std::string _name;
 
    IOChannelRequester* _iochanRequester;
 
    ConnectionThread* _connectionThread;
 
    bool _firstRead;
 
    bool _newInput;
 
    int _keepAliveIdleSecs;
 
    bool _nonBlocking;
 
    nidas::util::Mutex _connectionMutex;
 
    enum McSocketRequest _requestType;
 
    Socket& operator=(const Socket&);
};
 
class ServerSocket: public IOChannel {
 
public:
 
    ServerSocket();
 
    ServerSocket(const nidas::util::SocketAddress& addr);
 
    ~ServerSocket();
 
    ServerSocket* clone() const;
 
    void requestConnection(IOChannelRequester* service);
 
    IOChannel* connect();
 
    const std::string& getName() const { return _name; }
 
    void setName(const std::string& val) { _name = val; }
 
    int getFd() const
    {
        if (_servSock) return _servSock->getFd();
    return -1;
    }
 
    void setKeepAliveIdleSecs(int val)
    {
        _keepAliveIdleSecs = val;
    }
 
    int getKeepAliveIdleSecs() const
    {
        return _keepAliveIdleSecs;
    }
 
    void setNonBlocking(bool val)
    {
        _nonBlocking = val;
    }
 
    bool isNonBlocking() const
    {
        return _nonBlocking;
    }
 
    size_t read(void*, size_t)
    {
        assert(false);
        return 0;
    }
 
    size_t write(const void*, size_t)
    {
        assert(false);
        return 0;
    }
 
    size_t write(const struct iovec*, int)
    {
        assert(false);
        return 0;
    }
 
    void close();
 
    static IOChannel* createSocket(const xercesc::DOMElement*);
 
    void fromDOMElement(const xercesc::DOMElement*);
 
    xercesc::DOMElement*
    toDOMParent(xercesc::DOMElement* parent, bool complete) const;
 
    xercesc::DOMElement*
    toDOMElement(xercesc::DOMElement* node, bool complete) const;
 
    class ConnectionThread: public nidas::util::Thread
    {
    public:
        ConnectionThread(ServerSocket* sock);
        int run();
        void interrupt();
 
    private:
        ServerSocket* _socket;
        ConnectionThread(const ConnectionThread&);
        ConnectionThread& operator=(const ConnectionThread&);
    };
 
protected:
    ServerSocket(const ServerSocket& x);
 
private:
 
    nidas::util::auto_ptr<nidas::util::SocketAddress> _localSockAddr;
 
    std::string _name;
 
    nidas::util::ServerSocket* _servSock;
 
    IOChannelRequester* _iochanRequester;
 
    ConnectionThread* _connectionThread;
 
    // friend class ServerSocketConnectionThread;
 
    int _keepAliveIdleSecs;
 
    bool _nonBlocking;
 
    ServerSocket& operator=(const ServerSocket&);
 
};
 
}}  // namespace nidas namespace core
 
#endif