Server.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.
// 
//  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_SERVER_H
#define DDC_SERVER_H

#include "ServerOptions.h"
#include "ServerStats.h"
#include "../CommonLib/CHost.h"
#include "../ConcordLib/ConcHolder.h"
#include "../CommonLib/ddcThreadQueue.h"

#ifdef WIN32
#include <process.h>  /* _beginthread, _endthread */
#else
#endif

//#define DEBUG_HIT_SORT
#ifdef DEBUG_HIT_SORT
# define HSDEBUG(s) ddcLog(s)
# define HIT_SORT_DEBUG(x) x
#else
# define HSDEBUG(s)
# define HIT_SORT_DEBUG(x)
#endif

//==============================================================================
class CDDCServer : public CHost
{
public:
    static const char *AdditionalHitDelimiter;

    static const size_t MaxSubhostsSize = 256;

    DDCVersionT m_VersionCompat;

    time_t m_tStarted;

    CDDCServerStats m_ServerStats;

    CDDCServerStats m_SessionStats;

    /* whether to log "normal" requests received in ProcessSocketString() */
    bool m_bLogRequests;

    /* set of request commands NOT to be logged (e.g. "status", "info", etc.) */
    set<string> m_noLogCommands;

    /* FQDN if available, otherwise symbolic hostname as returned by gethostname() */
    string m_FQHostName;

    size_t m_nWorkers;

    size_t m_ThreadQueueSize;

    double m_SlowQueryTimeout;

    size_t m_WorkerId;

    class CDDCServerThreadPool *m_ThreadPool;

public:
    //--------------------------------------------------------------
    // Constructors etc.

    CDDCServer();

    virtual ~CDDCServer()
    { this->Shutdown(); };
    
    virtual void Shutdown(bool quiet=false);

    virtual void SetOptions(const CDDCServerOptions &Options);

public:
    //--------------------------------------------------------------
    // DDCServer API: client threads

    virtual void StartClientThreads();

    virtual CDDCServer* WorkerClone(void) const
    { return new CDDCServer(); };

    virtual void WorkerCloneInit(const CDDCServer *Parent, size_t WorkerId);

    virtual void WorkerCloneFree(void);

    inline bool UseClientThreads(void) const
    { return m_ThreadPool!=NULL; };

public:
    //--------------------------------------------------------------
    // CHost API: socket handlers

    virtual void RunThread();

    virtual void HandleClientConnection(SOCKET& rConnectedSocket);
    
    virtual string ProcessSocketString(const string& SocketInput, SOCKET& rConnectedSocket);

public:
    //--------------------------------------------------------------
    // DDCServer API: request handlers: required

    virtual void handle__get_first_hits(string &Result, const char *Query, int TimeOut, size_t ResultLimit, const string& ReqPath, const NavHint& Hint);

    virtual void handle__get_hit_strings(string &Result, const char *ResultType, size_t StartHitNo, size_t ResultLimit);

    virtual void handle__run_query(string &Result, const char *CorpusName, const char *Query, const char *ResultType, size_t StartHitNo, size_t ResultLimit, int TimeOut, const string& ReqPath, const NavHint& Hint);

    virtual void handle__expand_terms(string &Result, const string& pipeline, const string& terms, int timeout, const string &corpus);

    virtual void handle__status(string &Result, int timeout=10, bool verbose=false);

    virtual void handle__info(string &Result, int timeout=10, bool verbose=false);

    virtual void handle__reload(string &Result, int depth=0);

    virtual void handle__clear_cache(string &Result, int depth=0);

    virtual void handle__nodes(string &Result, int depth=-1);

public:
    //--------------------------------------------------------------
    // DDCServer API: request handlers: optional

    virtual void handle__get_first_hits(string &Result, const char *Query, int TimeOut, size_t ResultLimit);

    virtual void handle__run_query(string &Result, const char *CorpusName, const char *Query, const char *ResultType, size_t StartHitNo, size_t ResultLimit, int TimeOut);

    virtual void handle__get_paradigm(string &Result, const char *Word, int iLemmatizeOnly, int iLang);

    virtual void handle__close_socket(string &Result, SOCKET &rConnectedSocket);

    virtual void handle__version(string &Result);

    virtual void handle__vstatus(string &Result, int timeout=10);

    virtual void handle__vinfo(string &Result, int timeout=10);

public:
    //--------------------------------------------------------------
    // DDCServer: utilities
    inline void method_not_implemented(const char *methodName)
    { throw CExpc(errRuntime, "DDCServer API method %s not implemented for object %s", methodName, typeid(*this).name()); };
    
    virtual size_t residentMemorySize(void) const;

    virtual size_t totalMemorySize(void) const;

    void findPathHint(const string& ReqStr, size_t StartPos, size_t &PathPos, size_t &HintPos);
};

#endif /* DDC_SERVER_H */

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