Merge TinyOS 2.1.1 into master.

[tinyos-2.x.git] / tos / lib / net / dhv / DisseminatorP.nc

diff --git a/tos/lib/net/dhv/DisseminatorP.nc b/tos/lib/net/dhv/DisseminatorP.nc
new file mode 100755 (executable)
index 0000000..6ecec98
--- /dev/null
+++ b/tos/lib/net/dhv/DisseminatorP.nc
@@ -0,0 +1,109 @@
+/*
+ * Copyright (c) 2006 Arch Rock Corporation
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * - Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ * - Redistributions in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the
+ *   distribution.
+ * - Neither the name of the Arch Rock Corporation nor the names of
+ *   its contributors may be used to endorse or promote products derived
+ *   from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
+ * ARCHED ROCK OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+ * OF THE POSSIBILITY OF SUCH DAMAGE
+ *
+ */
+
+/**
+ * The DisseminatorP module holds and synchronizes a single value of a
+ * chosen type.
+ *
+ * See TEP118 - Dissemination for details.
+ * 
+ * @param t the type of the object that will be disseminated
+ *
+ * @author Gilman Tolle <gtolle@archrock.com>
+ * @version $Revision$ $Date$
+ */
+
+generic module DisseminatorP(typedef t, dhv_key_t key) {
+  provides interface DisseminationValue<t> as AppDisseminationValue;
+  provides interface DisseminationUpdate<t> as AppDisseminationUpdate;
+  provides interface DisseminationUpdate<dhv_data_t> as DataDisseminationUpdate;
+  provides interface DisseminationValue<dhv_data_t> as DataDisseminationValue;
+
+  provides interface Init;
+
+  uses interface DisseminationUpdate<dhv_data_t> as DhvDisseminationUpdate;
+  uses interface DhvHelp;
+  uses interface Leds;
+}
+implementation {
+  dhv_data_t valueCache;
+  
+  task void signalNewData() {
+    signal AppDisseminationValue.changed();
+  }
+  
+  command error_t Init.init() {
+    call DhvHelp.registerKey(key);
+    return SUCCESS;
+  }
+
+  // A sequence number is 32 bits. The top 16 bits are an incrementing
+  // counter, while the bottom 16 bits are a unique node identifier.
+  // But versions aren't stored here.
+
+  command const t* AppDisseminationValue.get() {
+    return (t*) &valueCache;
+  }
+
+  command void AppDisseminationValue.set( const t* val ) {
+    memcpy( &valueCache, val, sizeof(t) );
+    // must signal here instead of posting task to prevent race condition
+    signal AppDisseminationValue.changed();
+  }
+
+  command void AppDisseminationUpdate.change( t* newVal ) {
+    memcpy( &valueCache, newVal, sizeof(t) );
+    /* Increment the counter and append the local node ID later. */
+    /* DhvLogicC doesn't care what the data actually is,
+       it just wants the key, so we cast it recklessly */
+    call DhvDisseminationUpdate.change((dhv_data_t*)newVal);
+    post signalNewData();
+  }
+
+  command const dhv_data_t* DataDisseminationValue.get() {
+    return (dhv_data_t*) &valueCache;
+  }
+
+  command void DataDisseminationValue.set( const dhv_data_t* val ) {  }
+
+  command void DataDisseminationUpdate.change( dhv_data_t* newVal ) {
+    memcpy( &valueCache, newVal, sizeof(dhv_data_t) );
+    // don't post the task, this came from the network
+    signal AppDisseminationValue.changed();
+  }
+
+
+  default event void AppDisseminationValue.changed() { }
+
+  default event void DataDisseminationValue.changed() { }
+
+}