NullResponseHandler.h

// NullResponseHandler.h
 
// This file is part of bes, A C++ back-end server implementation framework
// for the OPeNDAP Data Access Protocol.
 
// Copyright (c) 2018 OPeNDAP, Inc
// Author: James Gallagher <jgallagher@opendap.org>
//
// 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 OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.
 
#ifndef NullResponseHandler_h
#define NullResponseHandler_h 1
 
#include "BESResponseHandler.h"
 
namespace bes {

class NullResponseHandler: public BESResponseHandler {
public:
 
    NullResponseHandler(const std::string &name): BESResponseHandler(name) { }
    virtual ~NullResponseHandler(void) { }

    virtual void execute(BESDataHandlerInterface &/*dhi*/) {
        // This would be used in the transmit() method below to send a response back to the
        // BES's client, if this command returned data. Since it does not, this can be NULL
        // and the transmit() method can be a no-op. jhrg 2/8/18
        d_response_object = 0;
    }

    virtual void transmit(BESTransmitter */*transmitter*/, BESDataHandlerInterface &/*dhi*/) { }
 
    virtual void dump(std::ostream &strm) const {
        strm << BESIndent::LMarg << "NullResponseHandler::dump - (" << (void *) this << ")" << std::endl;
        BESIndent::Indent();
        BESResponseHandler::dump(strm);
        BESIndent::UnIndent();
    }
 
 
    // Factory method, used by the DefaultModule to add this to the list of
    // ResponseHandlers for a given 'action'
    static BESResponseHandler *NullResponseBuilder(const std::string &name) {
        return new NullResponseHandler(name);
    }
};
 
}   // namespace bes
 
#endif // NullResponseHandler_h