bes  Updated for version 3.20.6
NullResponseHandler.h
1 // NullResponseHandler.h
2 
3 // This file is part of bes, A C++ back-end server implementation framework
4 // for the OPeNDAP Data Access Protocol.
5 
6 // Copyright (c) 2018 OPeNDAP, Inc
7 // Author: James Gallagher <jgallagher@opendap.org>
8 //
9 // This library is free software; you can redistribute it and/or
10 // modify it under the terms of the GNU Lesser General Public
11 // License as published by the Free Software Foundation; either
12 // version 2.1 of the License, or (at your option) any later version.
13 //
14 // This library is distributed in the hope that it will be useful,
15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 // Lesser General Public License for more details.
18 //
19 // You should have received a copy of the GNU Lesser General Public
20 // License along with this library; if not, write to the Free Software
21 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 //
23 // You can contact OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.
24 
25 #ifndef NullResponseHandler_h
26 #define NullResponseHandler_h 1
27 
28 #include "BESResponseHandler.h"
29 
30 namespace bes {
31 
47 public:
48 
49  NullResponseHandler(const std::string &name): BESResponseHandler(name) { }
50  virtual ~NullResponseHandler(void) { }
51 
59  virtual void execute(BESDataHandlerInterface &/*dhi*/) {
60  // This would be used in the transmit() method below to send a response back to the
61  // BES's client, if this command returned data. Since it does not, this can be NULL
62  // and the transmit() method can be a no-op. jhrg 2/8/18
63  d_response_object = 0;
64  }
65 
74  virtual void transmit(BESTransmitter */*transmitter*/, BESDataHandlerInterface &/*dhi*/) { }
75 
76  virtual void dump(std::ostream &strm) const {
77  strm << BESIndent::LMarg << "NullResponseHandler::dump - (" << (void *) this << ")" << std::endl;
78  BESIndent::Indent();
80  BESIndent::UnIndent();
81  }
82 
83 
84  // Factory method, used by the DefaultModule to add this to the list of
85  // ResponseHandlers for a given 'action'
86  static BESResponseHandler *NullResponseBuilder(const std::string &name) {
87  return new NullResponseHandler(name);
88  }
89 };
90 
91 } // namespace bes
92 
93 #endif // NullResponseHandler_h
94 
bes::NullResponseHandler::transmit
virtual void transmit(BESTransmitter *, BESDataHandlerInterface &)
This is a no-op.
Definition: NullResponseHandler.h:74
bes::NullResponseHandler::execute
virtual void execute(BESDataHandlerInterface &)
Minimal execution.
Definition: NullResponseHandler.h:59
bes::NullResponseHandler
A ResponseHandler that does nothing.
Definition: NullResponseHandler.h:46
BESResponseHandler::dump
virtual void dump(std::ostream &strm) const
dumps information about this object
Definition: BESResponseHandler.cc:102
bes::NullResponseHandler::dump
virtual void dump(std::ostream &strm) const
dumps information about this object
Definition: NullResponseHandler.h:76
BESResponseHandler
handler object that knows how to create a specific response object
Definition: BESResponseHandler.h:77
BESTransmitter
Definition: BESTransmitter.h:47
BESDataHandlerInterface
Structure storing information used by the BES to handle the request.
Definition: BESDataHandlerInterface.h:56