OPeNDAP Hyrax Back End Server (BES) Updated for version 3.8.3
BESInterface.h
Go to the documentation of this file.
00001 // BESInterface.h
00002 
00003 // This file is part of bes, A C++ back-end server implementation framework
00004 // for the OPeNDAP Data Access Protocol.
00005 
00006 // Copyright (c) 2004-2009 University Corporation for Atmospheric Research
00007 // Author: Patrick West <pwest@ucar.edu> and Jose Garcia <jgarcia@ucar.edu>
00008 //
00009 // This library is free software; you can redistribute it and/or
00010 // modify it under the terms of the GNU Lesser General Public
00011 // License as published by the Free Software Foundation; either
00012 // version 2.1 of the License, or (at your option) any later version.
00013 // 
00014 // This library is distributed in the hope that it will be useful,
00015 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00016 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00017 // Lesser General Public License for more details.
00018 // 
00019 // You should have received a copy of the GNU Lesser General Public
00020 // License along with this library; if not, write to the Free Software
00021 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00022 //
00023 // You can contact University Corporation for Atmospheric Research at
00024 // 3080 Center Green Drive, Boulder, CO 80301
00025  
00026 // (c) COPYRIGHT University Corporation for Atmospheric Research 2004-2005
00027 // Please read the full copyright statement in the file COPYRIGHT_UCAR.
00028 //
00029 // Authors:
00030 //      pwest       Patrick West <pwest@ucar.edu>
00031 //      jgarcia     Jose Garcia <jgarcia@ucar.edu>
00032 
00033 #ifndef BESInterface_h_
00034 #define BESInterface_h_ 1
00035 
00036 #include <list>
00037 
00038 using std::list ;
00039 
00040 #include "BESDataHandlerInterface.h"
00041 
00042 #include "BESObj.h"
00043 
00044 class BESError ;
00045 class BESTransmitter ;
00046 
00047 typedef bool (*p_bes_init)( BESDataHandlerInterface &dhi ) ;
00048 typedef void (*p_bes_end)( BESDataHandlerInterface &dhi ) ;
00049 
00123 class BESInterface : public BESObj
00124 {
00125 private:
00126     typedef list< p_bes_init >::const_iterator init_citer ;
00127     typedef list< p_bes_init >::iterator init_iter ;
00128     static list< p_bes_init > _init_list ;
00129 
00130     typedef list< p_bes_end >::const_iterator end_citer ;
00131     typedef list< p_bes_end >::iterator end_iter ;
00132     static list< p_bes_end > _end_list ;
00133 
00134     ostream                     *_strm ;
00135 protected:
00136     BESDataHandlerInterface     *_dhi ;
00137     BESTransmitter              *_transmitter ;
00138 
00139     virtual int                 exception_manager( BESError &e ) ;
00140     virtual void                initialize() ;
00141     virtual void                validate_data_request() ;
00142 
00151     virtual void                build_data_request_plan() = 0 ;
00152 
00153     virtual void                execute_data_request_plan() ;
00154     virtual void                invoke_aggregation() ;
00155 
00156     virtual int                 finish( int status ) ;
00157     virtual void                transmit_data() ;
00158     virtual void                log_status() ;
00159     virtual void                report_request() ;
00160     virtual void                end_request() ;
00161     virtual void                clean() ;
00162 
00163                                 BESInterface( ostream *strm ) ;
00164     virtual                     ~BESInterface() ;
00165 public:
00166     virtual int                 execute_request( const string &from ) ;
00167     virtual int                 finish_with_error( int status ) ;
00168 
00169     virtual void                dump( ostream &strm ) const ;
00170 
00171     static void                 add_init_callback( p_bes_init init ) ;
00172     static void                 add_end_callback( p_bes_end end ) ;
00173 } ;
00174 
00175 #endif // BESInterface_h_
00176