CHost.h

Go to the documentation of this file.

//-*- Mode: C++ -*-
//
//  DDC originally by Alexey Sokirko
//  Changes and modifications 2011-2020 by Bryan Jurish
//
//  This file is part of DDC (fomerly defined in string_socket.h)
// 
//  DDC 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 3 of the License, or
//  (at your option) any later version.
// 
//  DDC 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 DDC.  If not, see <http://www.gnu.org/licenses/>.
//
#ifndef _DDC_CHOST_H
#define _DDC_CHOST_H

#include "utilit.h"
#include "string_socket.h"

//======================================================================
class CHost  
{
    bool            m_bListen;
    SOCKET          m_ListenSocket;

protected:
    CSocketAddr     m_SockAddr;     
    bool            m_bExpectMore;  
    bool            m_bRespond;     
    bool            m_bLogFinish;   
    string          m_LocalPath;    
    uint32_t        m_maxReceiveBytes; 
    mode_t          m_UnixSocketPerms; 

    int             CreateSocket(bool bBind, string& strError) const;
    bool            CheckValidAddr() const;
    void            StopListening ();
public:
    string          m_CorpusName;       
    string          m_ShortName;        
        
    CHost();
    virtual ~CHost();
    bool                    ReadFromString (string S);

    virtual void            CreateListener();
    void                    CopyAddressParametersFrom(const CHost& X);
    bool                    CloseListenSocket(int timeout=0);

    virtual void            RunThread();
        
    int                     CreateAndConnectSocket(string& strError) const;
    string                  GetAddressStr() const;
    const string&           GetLocalPathOfIndex() const;
    
    inline const CSocketAddr& SocketAddr() const { return m_SockAddr; };
    inline const string&    HostAddr() const { return m_SockAddr.m_Addr; };
    inline const int        Port() const { return m_SockAddr.m_Port; };

    

    bool InitEmbedded(const CHost&);

    void InitShortName();

    bool IsListening () const {return m_bListen; };

public:
    bool GetRequest   (SOCKET& rConnectedSocket, int TimeOut, string &Request);

    void SendResponse (SOCKET& rConnectedSocket, const string& Result);

    void HandleSocketError(SOCKET& rConnectedSocket, const string& ErrorStr="ERROR", const string& Where="CHost::HandleSocketError()");

    void HandleClientRequest(SOCKET& rConnectedSocket, int TimeOut);

    virtual void HandleClientConnection(SOCKET& rConnectedSocket);

public:
    virtual bool Close(SOCKET& rConnectedSocket, bool linger=false, int timeout=5);

    virtual string  ProcessSocketString(const string& S, SOCKET& rConnectedSocket);

    virtual void    ClientError(int code=-1, const string& msg="");
    virtual void    ClientError(int code,    const string& msg, SOCKET& clientSocket);

};

//======================================================================
// load a DDC server config file
extern bool LoadHosts (string Path, vector<CHost>& Hosts);

        
#endif /* DDC_CHOST_H */

/*--- emacs style variables ---
 * Local Variables:
 *  mode: C++
 *  c-file-style: "ellemtel"
 *  c-basic-offset: 4
 *  tab-width: 8
 *  indent-tabs-mode: nil
 * End:
 */