LeafServer.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_LEAF_SERVER_H
#define DDC_LEAF_SERVER_H

#include "../ConcordDmnLib/BranchServer.h"

class CDDCLeafServer : public CDDCServer
{
public:
    //--------------------------------------------------------------
    // local corpus data
    CConcHolder* m_pHolder;

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

    CDDCLeafServer()
        : m_pHolder(NULL)
    {};

    virtual ~CDDCLeafServer()
    {};

    virtual void Shutdown();

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

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

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

    virtual void WorkerCloneFree(void);

public:
    //--------------------------------------------------------------
    // CHost API: overrides
    virtual bool Close(SOCKET& rConnectedSocket, bool linger=false, int timeout=5);

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);

    /* request handler: run_query: required (branch) */
    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:
    //--------------------------------------------------------------
    // local methods

    void LoadHolder(CConcHolder **ppHolder=NULL);

    void GetHitCounts(CRunQueryData &runq, DDCFormatTypeEnum ResultTypeE);

    void GetHitContexts(CRunQueryData &runq, DDCFormatTypeEnum ResultTypeE);
};

typedef CDDCLeafServer CDDCCorpusListenHost;


#endif /* DDC_LEAF_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:
 */