BESResponseHandler.h

// BESResponseHandler.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 I_BESResponseHandler_h
#define I_BESResponseHandler_h 1
 
#include <string>
 
#include "BESObj.h"
 
class BESResponseObject;
class BESDataHandlerInterface;
class BESTransmitter;

class BESResponseHandler: public BESObj {
protected:
    std::string d_response_name;
    BESResponseObject *d_response_object = nullptr;
 
    std::string d_annotation_service_url;   //< If not null, include this in the DAS/DMR
 
    friend class resplistT;
 
public:
    explicit BESResponseHandler(std::string name);
 
    ~BESResponseHandler() override;

    virtual BESResponseObject *get_response_object();

    virtual BESResponseObject *set_response_object(BESResponseObject *o);

    virtual void execute(BESDataHandlerInterface &dhi) = 0;

    virtual void transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi) = 0;
 
    void dump(std::ostream &strm) const override;
};
 
#endif // I_BESResponseHandler_h