bes  Updated for version 3.17.0
SampleSayResponseHandler.cc
1 // SampleSayResponseHandler.cc
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 #include "SampleSayResponseHandler.h"
34 #include "BESInfoList.h"
35 #include "BESInfo.h"
36 #include "SampleResponseNames.h"
37 
38 SampleSayResponseHandler::SampleSayResponseHandler( const string &name )
39  : BESResponseHandler( name )
40 {
41 }
42 
43 SampleSayResponseHandler::~SampleSayResponseHandler( )
44 {
45 }
46 
47 void
49 {
50  // This is an example. Here you would build the BESResponseObject
51  // object and set it to the _response protected data member
52  BESInfo *info = BESInfoList::TheList()->build_info() ;
53  _response = info ;
54 
55  // Here is where your code would fill in the new response object
56  info->begin_response( SAY_RESPONSE, dhi ) ;
57  string str = dhi.data[ SAY_WHAT ] + " " + dhi.data[ SAY_TO ] ;
58  info->add_tag( "text", str ) ;
59  info->end_response() ;
60 }
61 
62 void
65 {
66  // Here is where you would transmit your response object using the
67  // specified transmitter object. This is the example using the BESInfo
68  // response object
69  if( _response )
70  {
71  BESInfo *info = dynamic_cast<BESInfo *>( _response ) ;
72  info->transmit( transmitter, dhi ) ;
73  }
74 }
75 
76 void
77 SampleSayResponseHandler::dump( ostream &strm ) const
78 {
79  strm << BESIndent::LMarg << "SampleSayResponseHandler::dump - ("
80  << (void *)this << ")" << endl ;
81  BESIndent::Indent() ;
82  BESResponseHandler::dump( strm ) ;
83  BESIndent::UnIndent() ;
84 }
85 
87 SampleSayResponseHandler::SampleSayResponseBuilder( const string &name )
88 {
89  return new SampleSayResponseHandler( name ) ;
90 }
91 
virtual void execute(BESDataHandlerInterface &dhi)
knows how to build a requested response object
virtual void transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi)=0
transmit the informational object
handler object that knows how to create a specific response object
informational response object
Definition: BESInfo.h:68
virtual void dump(ostream &strm) const
dumps information about this object
virtual void dump(ostream &strm) const
dumps information about this object
Structure storing information used by the BES to handle the request.
map< string, string > data
the map of string data that will be required for the current request.
virtual void transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
transmit the response object built by the execute command using the specified transmitter object ...
virtual void begin_response(const string &response_name, BESDataHandlerInterface &dhi)
begin the informational response
Definition: BESInfo.cc:112