bes  Updated for version 3.20.10
BESContainerStorageList.h
1 // BESContainerStorageList.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_BESContainerStorageList_H
34 #define I_BESContainerStorageList_H 1
35 
36 #include <string>
37 #include <mutex>
38 
39 #include "BESObj.h"
40 
42 class BESContainer;
43 class BESInfo;
44 
45 #ifndef DEFAULT
46 #define DEFAULT "default"
47 #endif
48 
49 #ifndef CATALOG
50 #define CATALOG "catalog"
51 #endif
52 
73 private:
74  static BESContainerStorageList * d_instance;
75  mutable std::recursive_mutex d_cache_lock_mutex;
76 
77  typedef struct _persistence_list {
78  BESContainerStorage *_persistence_obj;
79  unsigned int _reference;
80  BESContainerStorageList::_persistence_list *_next;
81  } persistence_list;
82 
83  BESContainerStorageList::persistence_list *_first;
84 
85  static void initialize_instance();
86  static void delete_instance();
87 
88 public:
90  virtual ~BESContainerStorageList();
91 
92  virtual bool add_persistence(BESContainerStorage *p);
93  virtual bool ref_persistence(const std::string &persist_name);
94  virtual bool deref_persistence(const std::string &persist_name);
95  virtual BESContainerStorage *find_persistence(const std::string &persist_name);
96  virtual bool isnice();
97 
98  // These methods scan all of the container stores. Currently, this is used
99  // by both <setContainer> and <define>. However, a better design would disentangle
100  // the ContainerStorage from the Container creation. jhrg 1/8/19
101  virtual BESContainer *look_for(const std::string &sym_name);
102  virtual void delete_container(const std::string &sym_name);
103 
104  virtual void show_containers(BESInfo &info);
105 
106  virtual void dump(std::ostream &strm) const;
107 
108  static BESContainerStorageList *TheList();
109 };
110 
111 #endif // I_BESContainerStorageList_H
112 
Provides a mechanism for accessing container information from different container stores registered w...
virtual bool ref_persistence(const std::string &persist_name)
refence the specified persistent store if in the list
virtual void show_containers(BESInfo &info)
show information for each container in each persistence store
virtual void dump(std::ostream &strm) const
dumps information about this object
virtual bool add_persistence(BESContainerStorage *p)
Add a persistent store to the list.
virtual BESContainer * look_for(const std::string &sym_name)
look for the specified container information in the list of persistent stores.
virtual void delete_container(const std::string &sym_name)
scan all of the container stores and remove any containers called
virtual bool deref_persistence(const std::string &persist_name)
dereference a persistent store in the list.
virtual BESContainerStorage * find_persistence(const std::string &persist_name)
find the persistence store with the given name
provides persistent storage for data storage information represented by a container.
A container is something that holds data. E.G., a netcdf file or a database entry.
Definition: BESContainer.h:65
informational response object
Definition: BESInfo.h:63
top level BES object to house generic methods
Definition: BESObj.h:50