Rename all apt-dht files to apt-p2p.

[quix0rs-apt-p2p.git] / apt_p2p / interfaces.py

diff --git a/apt_p2p/interfaces.py b/apt_p2p/interfaces.py
new file mode 100644 (file)
index 0000000..b38de39
--- /dev/null
+++ b/apt_p2p/interfaces.py
@@ -0,0 +1,43 @@
+
+"""Some interfaces that are used by the apt-p2p classes."""
+
+from zope.interface import Interface
+
+class IDHT(Interface):
+    """An abstract interface for using a DHT implementation."""
+    
+    def loadConfig(self, config, section):
+        """Load the DHTs configuration from a dictionary.
+        
+        @type config: C{SafeConfigParser}
+        @param config: the dictionary of config values
+        """
+    
+    def join(self):
+        """Bootstrap the new DHT node into the DHT.
+        
+        @rtype: C{Deferred}
+        @return: a deferred that will fire when the node has joined
+        """
+        
+    def leave(self):
+        """Depart gracefully from the DHT.
+        
+        @rtype: C{Deferred}
+        @return: a deferred that will fire when the node has left
+        """
+        
+    def getValue(self, key):
+        """Get a value from the DHT for the specified key.
+        
+        The length of the key may be adjusted for use with the DHT.
+
+        @rtype: C{Deferred}
+        @return: a deferred that will fire with the stored values
+        """
+        
+    def storeValue(self, key, value):
+        """Store a value in the DHT for the specified key.
+
+        The length of the key may be adjusted for use with the DHT.
+        """