servlib/storage/GlobalStore.h
changeset 0 2b3e5ec03512
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/servlib/storage/GlobalStore.h	Thu Apr 21 14:57:45 2011 +0100
@@ -0,0 +1,131 @@
+/*
+ *    Copyright 2004-2006 Intel Corporation
+ * 
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ * 
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+
+#ifndef _GLOBAL_STORE_H_
+#define _GLOBAL_STORE_H_
+
+#include <oasys/debug/DebugUtils.h>
+#include <oasys/debug/Log.h>
+#include <oasys/serialize/Serialize.h>
+
+// forward decl
+namespace oasys {
+template<typename _Type> class SingleTypeDurableTable;
+class DurableStore;
+class Mutex;
+class StorageConfig;
+}
+
+namespace dtn {
+
+class Globals;
+
+/**
+ * Class for those elements of the router that need to be persistently
+ * stored but are singleton global values. Examples include the
+ * running sequence number for bundles and registrations, as well as
+ * any other persistent configuration settings.
+ */
+class GlobalStore : public oasys::Logger {
+public:
+    static const u_int32_t CURRENT_VERSION;
+    
+    /**
+     * Singleton instance accessor.
+     */
+    static GlobalStore* instance() {
+        if (instance_ == NULL) {
+            PANIC("GlobalStore::init not called yet");
+        }
+        return instance_;
+    }
+
+    /**
+     * Boot time initializer
+     *
+     */
+    static int init(const oasys::StorageConfig& cfg, 
+                    oasys::DurableStore*        store);
+
+    /**
+     * Constructor.
+     */
+    GlobalStore();
+
+    /**
+     * Real initialization method.
+     */
+    int do_init(const oasys::StorageConfig& cfg, 
+                oasys::DurableStore*        store);
+    
+    /**
+     * Return true if initialization has completed.
+     */
+    static bool initialized() { return (instance_ != NULL); }
+    
+    /**
+     * Destructor.
+     */
+    ~GlobalStore();
+
+    /**
+     * Get a new bundle id, updating the value in the store
+     *
+     * (was db_update_bundle_id, db_restore_bundle_id)
+     */
+    u_int32_t next_bundleid();
+    
+    /**
+     * Get a new unique registration id, updating the running value in
+     * the persistent table.
+     *
+     * (was db_new_regID, db_update_registration_id,
+     * db_retable_registration_id)
+     */
+    u_int32_t next_regid();
+
+    /**
+     * Load in the globals.
+     */
+    bool load();
+
+    /**
+     * Close (and flush) the data store.
+     */
+    void close();
+
+protected:
+    /**
+     * Update the globals in the store.
+     */
+    void update();
+
+    /**
+     * Calculate a digest of on-disk serialized objects.
+     */
+    void calc_digest(u_char* digest);
+
+    bool loaded_;
+    Globals* globals_;
+    oasys::SingleTypeDurableTable<Globals>* store_;
+
+    oasys::Mutex* lock_;
+
+    static GlobalStore* instance_; ///< singleton instance
+};
+} // namespace dtn
+
+#endif /* _GLOBAL_STORE_H_ */