bes  Updated for version 3.20.6
BESHelpResponseHandler.h
1 // BESHelpResponseHandler.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) 2004-2009 University Corporation for Atmospheric Research
7 // Author: Patrick West <pwest@ucar.edu> and Jose Garcia <jgarcia@ucar.edu>
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 University Corporation for Atmospheric Research at
24 // 3080 Center Green Drive, Boulder, CO 80301
25 
26 // (c) COPYRIGHT University Corporation for Atmospheric Research 2004-2005
27 // Please read the full copyright statement in the file COPYRIGHT_UCAR.
28 //
29 // Authors:
30 // pwest Patrick West <pwest@ucar.edu>
31 // jgarcia Jose Garcia <jgarcia@ucar.edu>
32 
33 #ifndef I_BESHelpResponseHandler_h
34 #define I_BESHelpResponseHandler_h 1
35 
36 #include "BESResponseHandler.h"
37 
53 {
54 public:
55  BESHelpResponseHandler( const std::string &name ) ;
56  virtual ~BESHelpResponseHandler( void ) ;
57 
58  virtual void execute( BESDataHandlerInterface &dhi ) ;
59  virtual void transmit( BESTransmitter *transmitter,
61 
62  virtual void dump( std::ostream &strm ) const ;
63 
64  static BESResponseHandler *HelpResponseBuilder( const std::string &name ) ;
65 };
66 
67 #endif // I_BESHelpResponseHandler_h
68 
BESHelpResponseHandler::transmit
virtual void transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
transmit the response object built by the execute command using the specified transmitter object
Definition: BESHelpResponseHandler.cc:111
BESHelpResponseHandler::dump
virtual void dump(std::ostream &strm) const
dumps information about this object
Definition: BESHelpResponseHandler.cc:130
BESHelpResponseHandler::execute
virtual void execute(BESDataHandlerInterface &dhi)
executes the command 'show help;' by returning general help information as well as help information f...
Definition: BESHelpResponseHandler.cc:75
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
BESHelpResponseHandler
response handler that returns help information about the server and currently loaded modules.
Definition: BESHelpResponseHandler.h:52