Document the recovery procedure
authorClaudio-Daniel Freire <claudio-daniel.freire@inria.fr>
Thu, 28 Jul 2011 10:00:03 +0000 (12:00 +0200)
committerClaudio-Daniel Freire <claudio-daniel.freire@inria.fr>
Thu, 28 Jul 2011 10:00:03 +0000 (12:00 +0200)
src/nepi/core/execute.py

index 44c9c24..9d30f5a 100644 (file)
@@ -147,6 +147,17 @@ class TestbedController(object):
         raise NotImplementedError
 
     def recover(self):
+        """
+        On testbed recovery (if recovery is a supported policy), the controller
+        instance will be re-created and the following sequence invoked:
+        
+            do_setup
+            *recover*
+            <cross-connection methods>
+            
+        Start will not be called, and after cross connection invocations,
+        the testbed is supposed to be fully functional again.
+        """
         raise NotImplementedError
 
     def set(self, guid, name, value, time = TIME_NOW):