BESInterface.h

// BESInterface.h
 
// This file is part of bes, A C++ back-end server implementation framework
// for the OPeNDAP Data Access Protocol.
 
// Copyright (c) 2004-2009 University Corporation for Atmospheric Research
// Author: Patrick West <pwest@ucar.edu> and Jose Garcia <jgarcia@ucar.edu>
//
// This library 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 2.1 of the License, or (at your option) any later version.
// 
// This library 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 this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//
// You can contact University Corporation for Atmospheric Research at
// 3080 Center Green Drive, Boulder, CO 80301
 
// (c) COPYRIGHT University Corporation for Atmospheric Research 2004-2005
// Please read the full copyright statement in the file COPYRIGHT_UCAR.
//
// Authors:
//      pwest       Patrick West <pwest@ucar.edu>
//      jgarcia     Jose Garcia <jgarcia@ucar.edu>
 
#ifndef BESInterface_h_
#define BESInterface_h_ 1
 
#include <string>
#include <ostream>
 
#include "BESObj.h"
 
class BESError;
class BESTransmitter;
class BESDataHandlerInterface;

class BESInterface: public BESObj {
private:
    std::ostream *d_strm {nullptr};
    int d_bes_timeout {0}; 
 
protected:
    BESDataHandlerInterface *d_dhi_ptr {nullptr}; 
    BESTransmitter *d_transmitter {nullptr};  
 
    virtual void end_request();
 
    virtual void build_data_request_plan() = 0;
 
    virtual void execute_data_request_plan() = 0;
 
    virtual void transmit_data() = 0;
 
    virtual void log_status() = 0;
 
    virtual void clean() = 0;
 
    explicit BESInterface(std::ostream *strm);
 
    ~BESInterface() override = default;
 
    static int handleException(const BESError &e, BESDataHandlerInterface &dhi);
 
    void set_bes_timeout();
    void clear_bes_timeout();
 
public:
    // This is the point where BESServerHandler::execute(Connection *c) passes control
    // to the 'run the command' part of the server. jhrg 11/7/17
    virtual int execute_request(const std::string &from);
 
    virtual int finish(int status);
 
    void dump(std::ostream &strm) const override;
};
 
#endif // BESInterface_h_