Merge pull request #1486 from dgelessus/vault_less_blocking

Fix a few blocking/callback issues in the vault API

Scripts/Python/nb01DRCImager.py

@@ -71,6 +71,10 @@ def doneAddingDevice(node,nodeRef,resultCode):
     "initializes new imager device with default inbox folder."
     PtDebugPrint("nb01DRCImager: doneAddingDevice, result code = %d" % resultCode)
 
+    if resultCode == 0:
+        PtDebugPrint("nb01DRCImager: doneAddingDevice, setting device inbox - %s" % ("DRCImagerState%d" % nb01DRCImager.Instance.current_state))
+        ptAgeVault().setDeviceInbox("DRCImager", "DRCImagerState%d" % nb01DRCImager.Instance.current_state, doneSettingDeviceInbox)
+
 #====================================
 class nb01DRCImager(ptModifier):
     Instance = None
@@ -156,8 +160,6 @@ def OnServerInitComplete(self):
 
             PtDebugPrint("nb01DRCImager.OnServerInitComplete: Adding device")
             ptAgeVault().addDevice("DRCImager",doneAddingDevice)
-            PtDebugPrint("nb01DRCImager.OnServerInitComplete: Setting device inbox - %s" % ("DRCImagerState%d" % self.current_state))
-            ptAgeVault().setDeviceInbox("DRCImager", "DRCImagerState%d" % self.current_state, doneSettingDeviceInbox)
 
     def OnTimer(self,id):
         PtDebugPrint("nb01DRCImager.OnTimer executing")

Scripts/Python/nxusBookMachine.py

@@ -581,14 +581,14 @@ def IMakeHoodPublic(self):
         hoodInfo = self.IGetHoodInfoNode()
         if hoodInfo is not None:
             infoStruct = hoodInfo.asAgeInfoStruct()
-            PtCreatePublicAge(infoStruct, self)
+            PtCreatePublicAge(infoStruct)
 
 
     def IMakeHoodPrivate(self):
         hoodInfo = self.IGetHoodInfoNode()
         if hoodInfo is not None:
             guid = hoodInfo.getAgeInstanceGuid()
-            PtRemovePublicAge(guid, self)
+            PtRemovePublicAge(guid)
 
     def IPublicAgeCreated(self, ageName):
         PtDebugPrint("IPublicAgeCreated: " + ageName)

Scripts/Python/plasma/Plasma.py

@@ -164,9 +164,8 @@ def PtCreatePlayer(playerName, avatarShape, invitation):
     """Creates a new player"""
     pass
 
-def PtCreatePublicAge(ageInfo, cbObject=None):
-    """Create a public instance of the given age.
-cbObject, if supplied should have a member called publicAgeCreated(self,ageInfo)"""
+def PtCreatePublicAge(ageInfo):
+    """Create a public instance of the given age."""
     pass
 
 def PtDebugAssert(cond, msg):
@@ -686,9 +685,8 @@ def PtRecenterCamera():
     """re-centers the camera"""
     pass
 
-def PtRemovePublicAge(ageInstanceGuid, cbObject=None):
-    """Remove a public instance of the given age.
-cbObject, if supplied should have a member called publicAgeRemoved(self,ageInstanceGuid)"""
+def PtRemovePublicAge(ageInstanceGuid):
+    """Remove a public instance of the given age."""
     pass
 
 def PtRequestLOSScreen(selfKey,ID,xPos,yPos,distance,what,reportType):
@@ -6531,10 +6529,6 @@ def registerVisitAge(self,link):
         """Register this age as visitable by this player"""
         pass
 
-    def sendToDevice(self,node,deviceName):
-        """Sends a ptVaultNode object to an Age's device by deviceName."""
-        pass
-
     def setAgePublic(self,ageInfo,makePublic):
         """Makes the specified age public or private"""
         pass

Sources/Plasma/FeatureLib/pfConsole/pfConsoleCommandsNet.cpp

@@ -750,7 +750,7 @@ PF_CONSOLE_CMD( Net_Vault,
                "string stationName, string mtSpawnPt",
                "Register an MT Station with your Nexus" )
 {
-    VaultRegisterMTStationAndWait(params[0], params[1]);
+    VaultRegisterMTStation(params[0], params[1]);
     PrintString("Registered MT Station.");
 }
 
@@ -779,7 +779,7 @@ PF_CONSOLE_CMD( Net_Vault,
 {
     plAgeInfoStruct info;
     info.SetAgeFilename(params[0]);
-    bool success = VaultUnregisterOwnedAgeAndWait(&info);
+    bool success = VaultUnregisterOwnedAge(&info);
     PrintString(ST::format("Operation {}.", success ? "Successful" : "Failed"));
 }
 
@@ -809,7 +809,7 @@ PF_CONSOLE_CMD( Net_Vault,
     info.SetAgeFilename(params[0]);
 
     unsigned count = 0;
-    while (VaultUnregisterVisitAgeAndWait(&info))
+    while (VaultUnregisterVisitAge(&info))
         ++count;
 
     PrintString(ST::format("Operation {}.", count > 0 ? "Successful" : "Failed"));

Sources/Plasma/FeatureLib/pfPython/cyMisc.cpp

@@ -2189,30 +2189,28 @@ void cyMisc::GetPublicAgeList(const ST::string& ageName, PyObject * cbObject)
 //////////////////////////////////////////////////////////////////////////////
 //
 // Function   : CreatePublicAge
-// PARAMETERS : ageInfo, callback object
+// PARAMETERS : ageInfo
 //
 // PURPOSE    : Add a public age to the list of available ones.
 //
-void cyMisc::CreatePublicAge( pyAgeInfoStruct * ageInfo, PyObject * cbObject )
+void cyMisc::CreatePublicAge(pyAgeInfoStruct* ageInfo)
 {
-    VaultSetOwnedAgePublicAndWait(ageInfo->GetAgeInfo(), true);
-    // TODO: make the callback here
+    VaultSetOwnedAgePublic(ageInfo->GetAgeInfo(), true);
 }
 
 //////////////////////////////////////////////////////////////////////////////
 //
 // Function   : RemovePublicAge
-// PARAMETERS : ageInstanceGuid, callback object
+// PARAMETERS : ageInstanceGuid
 //
 // PURPOSE    : Remove a public age from the list of available ones.
 //
-void cyMisc::RemovePublicAge(const ST::string& ageInstanceGuid, PyObject * cbObject/*=nullptr */)
+void cyMisc::RemovePublicAge(const ST::string& ageInstanceGuid)
 {
     plAgeInfoStruct info;
     plUUID uuid(ageInstanceGuid);
     info.SetAgeInstanceGuid(&uuid);
-    VaultSetOwnedAgePublicAndWait(&info, false);
-    // TODO: make the callback here
+    VaultSetOwnedAgePublic(&info, false);
 }
 
 int cyMisc::GetKILevel()

Sources/Plasma/FeatureLib/pfPython/cyMisc.h

@@ -753,20 +753,20 @@ class cyMisc
     //////////////////////////////////////////////////////////////////////////////
     //
     // Function   : CreatePublicAge
-    // PARAMETERS : ageInfo, callback object
+    // PARAMETERS : ageInfo
     //
     // PURPOSE    : Add a public age to the list of available ones.
     //
-    static void CreatePublicAge(pyAgeInfoStruct * ageInfo, PyObject * cbObject = nullptr);
+    static void CreatePublicAge(pyAgeInfoStruct* ageInfo);
 
     //////////////////////////////////////////////////////////////////////////////
     //
     // Function   : RemovePublicAge
-    // PARAMETERS : ageInstanceGuid, callback object
+    // PARAMETERS : ageInstanceGuid
     //
     // PURPOSE    : Remove a public age from the list of available ones.
     //
-    static void RemovePublicAge(const ST::string& ageInstanceGuid, PyObject * cbObject = nullptr);
+    static void RemovePublicAge(const ST::string& ageInstanceGuid);
 
     //////////////////////////////////////////////////////////////////////////////
     //

Sources/Plasma/FeatureLib/pfPython/cyMiscGlue4.cpp

@@ -243,37 +243,33 @@ PYTHON_GLOBAL_METHOD_DEFINITION(PtGetPublicAgeList, args, "Params: ageName, cbOb
     PYTHON_RETURN_NONE;
 }
 
-PYTHON_GLOBAL_METHOD_DEFINITION(PtCreatePublicAge, args, "Params: ageInfo, cbObject=None\nCreate a public instance of the given age.\n"
-            "cbObject, if supplied should have a member called publicAgeCreated(self,ageInfo)")
+PYTHON_GLOBAL_METHOD_DEFINITION(PtCreatePublicAge, args, "Params: ageInfo\nCreate a public instance of the given age.")
 {
     PyObject* ageInfoObj = nullptr;
-    PyObject* cbObject = nullptr;
-    if (!PyArg_ParseTuple(args, "O|O", &ageInfoObj, &cbObject))
+    if (!PyArg_ParseTuple(args, "O", &ageInfoObj))
     {
-        PyErr_SetString(PyExc_TypeError, "PtCreatePublicAge expects a ptAgeInfoStruct object and an optional object with a publicAgeCreated() method");
+        PyErr_SetString(PyExc_TypeError, "PtCreatePublicAge expects a ptAgeInfoStruct object");
         PYTHON_RETURN_ERROR;
     }
     if (!pyAgeInfoStruct::Check(ageInfoObj))
     {
-        PyErr_SetString(PyExc_TypeError, "PtCreatePublicAge expects a ptAgeInfoStruct object and an optional object with a publicAgeCreated() method");
+        PyErr_SetString(PyExc_TypeError, "PtCreatePublicAge expects a ptAgeInfoStruct object");
         PYTHON_RETURN_ERROR;
     }
     pyAgeInfoStruct* ageInfo = pyAgeInfoStruct::ConvertFrom(ageInfoObj);
-    cyMisc::CreatePublicAge(ageInfo, cbObject);
+    cyMisc::CreatePublicAge(ageInfo);
     PYTHON_RETURN_NONE;
 }
 
-PYTHON_GLOBAL_METHOD_DEFINITION(PtRemovePublicAge, args, "Params: ageInstanceGuid, cbObject=None\nRemove a public instance of the given age.\n"
-            "cbObject, if supplied should have a member called publicAgeRemoved(self,ageInstanceGuid)")
+PYTHON_GLOBAL_METHOD_DEFINITION(PtRemovePublicAge, args, "Params: ageInstanceGuid\nRemove a public instance of the given age.")
 {
     ST::string ageInstanceGUID;
-    PyObject* cbObject = nullptr;
-    if (!PyArg_ParseTuple(args, "O&|O", PyUnicode_STStringConverter, &ageInstanceGUID, &cbObject))
+    if (!PyArg_ParseTuple(args, "O&", PyUnicode_STStringConverter, &ageInstanceGUID))
     {
-        PyErr_SetString(PyExc_TypeError, "PtRemovePublicAge expects a string and an optional object with a publicAgeRemoved() method");
+        PyErr_SetString(PyExc_TypeError, "PtRemovePublicAge expects a string");
         PYTHON_RETURN_ERROR;
     }
-    cyMisc::RemovePublicAge(ageInstanceGUID, cbObject);
+    cyMisc::RemovePublicAge(ageInstanceGUID);
     PYTHON_RETURN_NONE;
 }
 

Sources/Plasma/FeatureLib/pfPython/pyAgeVault.cpp

@@ -176,18 +176,21 @@ void pyAgeVault::AddChronicleEntry( const ST::string& name, uint32_t type, const
     VaultAddAgeChronicleEntry(name, type, value);
 }
 
+static void _AddDeviceCallback(ENetError result, hsRef<RelVaultNode> device, void* param)
+{
+    auto cb = static_cast<pyVaultNode::pyVaultNodeOperationCallback*>(param);
+    cb->SetNode(std::move(device));
+    cb->VaultOperationComplete(result);
+}
+
 // AGE DEVICES. AKA IMAGERS, WHATEVER.
 // Add a new device.
 void pyAgeVault::AddDevice(const ST::string& deviceName, PyObject * cbObject, uint32_t cbContext)
 {
     pyVaultNode::pyVaultNodeOperationCallback * cb = new pyVaultNode::pyVaultNodeOperationCallback( cbObject );
     cb->VaultOperationStarted( cbContext );
 
-    if (hsRef<RelVaultNode> rvn = VaultAgeAddDeviceAndWait(deviceName))
-        cb->SetNode(rvn);
-
-    // cb deletes itself here.
-    cb->VaultOperationComplete(cbContext, cb->GetNode() ? kNetSuccess : kNetErrInternalError);
+    VaultAgeAddDevice(deviceName, _AddDeviceCallback, cb);
 }
 
 // Remove a device.
@@ -210,17 +213,20 @@ PyObject * pyAgeVault::GetDevice(const ST::string& deviceName)
     PYTHON_RETURN_NONE;
 }
 
+static void _SetDeviceInboxCallback(ENetError result, hsRef<RelVaultNode> inbox, void* param)
+{
+    auto cb = static_cast<pyVaultNode::pyVaultNodeOperationCallback*>(param);
+    cb->SetNode(std::move(inbox));
+    cb->VaultOperationComplete(result);
+}
+
 // Sets the inbox associated with a device.
 void pyAgeVault::SetDeviceInbox(const ST::string& deviceName, const ST::string& inboxName, PyObject * cbObject, uint32_t cbContext)
 {
     pyVaultNode::pyVaultNodeOperationCallback * cb = new pyVaultNode::pyVaultNodeOperationCallback( cbObject );
     cb->VaultOperationStarted( cbContext );
 
-    if (hsRef<RelVaultNode> rvn = VaultAgeSetDeviceInboxAndWait(deviceName, inboxName))
-        cb->SetNode(rvn);
-
-    // cb deletes itself here.
-    cb->VaultOperationComplete(cbContext, cb->GetNode() ? kNetSuccess : kNetErrInternalError);
+    VaultAgeSetDeviceInbox(deviceName, inboxName, _SetDeviceInboxCallback, cb);
 }
 
 PyObject * pyAgeVault::GetDeviceInbox(const ST::string& deviceName)

Sources/Plasma/FeatureLib/pfPython/pyVault.cpp

@@ -332,16 +332,6 @@ void pyVault::AddChronicleEntry(const ST::string& name, uint32_t type, const ST:
 }
 
 
-void pyVault::SendToDevice(pyVaultNode& node, const ST::string& deviceName)
-{
-    if (!node.GetNode())
-        return;
-
-    // Note: This actually blocks (~Hoikas)
-    VaultPublishNode(node.GetNode()->GetNodeId(), deviceName);
-}
-
-
 PyObject* pyVault::GetAgesICanVisitFolder()
 {
     PyObject * result = GetAgeInfoList(plVault::kAgesICanVisitFolder);
@@ -468,8 +458,7 @@ bool pyVault::AmAgeCzar( const pyAgeInfoStruct * ageInfo )
 
 void pyVault::RegisterMTStation( const ST::string& stationName, const ST::string& backLinkSpawnPtObjName )
 {
-    // Note: This doesn't actually block (~Hoikas)
-    VaultRegisterMTStationAndWait(stationName, backLinkSpawnPtObjName);
+    VaultRegisterMTStation(stationName, backLinkSpawnPtObjName);
 }
 
 void pyVault::RegisterOwnedAge( const pyAgeLinkStruct & link )
@@ -481,7 +470,7 @@ void pyVault::UnRegisterOwnedAge(const ST::string& ageFilename)
 {
     plAgeInfoStruct info;
     info.SetAgeFilename(ageFilename);
-    VaultUnregisterOwnedAgeAndWait(&info);
+    VaultUnregisterOwnedAge(&info);
 }
 
 void pyVault::RegisterVisitAge( const pyAgeLinkStruct & link )
@@ -494,7 +483,7 @@ void pyVault::UnRegisterVisitAge(const ST::string& guidstr)
     plAgeInfoStruct info;
     plUUID guid(guidstr);
     info.SetAgeInstanceGuid(&guid);
-    VaultUnregisterVisitAgeAndWait(&info);
+    VaultUnregisterVisitAge(&info);
 }
 
 //============================================================================
@@ -554,10 +543,9 @@ void pyVault::CreateNeighborhood()
     plNetClientMgr * nc = plNetClientMgr::GetInstance();
 
     // Unregister old hood
-    // Note: This doesn't actually block (~Hoikas)
     plAgeInfoStruct info;
     info.SetAgeFilename(kNeighborhoodAgeFilename);
-    VaultUnregisterOwnedAgeAndWait(&info);
+    VaultUnregisterOwnedAge(&info);
 
     // Register new hood    
     plAgeLinkStruct link;
@@ -588,13 +576,12 @@ void pyVault::CreateNeighborhood()
 
 bool pyVault::SetAgePublic( const pyAgeInfoStruct * ageInfo, bool makePublic )
 {
-    // Note: This doesn't actually block (~Hoikas)
-    return VaultSetOwnedAgePublicAndWait(ageInfo->GetAgeInfo(), makePublic);
+    return VaultSetOwnedAgePublic(ageInfo->GetAgeInfo(), makePublic);
 }
 
 bool pyVault::SetAgePublic( const pyVaultAgeInfoNode * ageInfoNode, bool makePublic )
 {
-    return VaultSetAgePublicAndWait(ageInfoNode->GetNode(), makePublic);
+    return VaultSetAgePublic(ageInfoNode->GetNode(), makePublic);
 }
 
 

Sources/Plasma/FeatureLib/pfPython/pyVault.h

@@ -122,9 +122,6 @@ class pyVault
     PyObject* FindChronicleEntry(const ST::string& entryName); // returns pyVaultChronicleNode
     void AddChronicleEntry(const ST::string& name, uint32_t type, const ST::string& value);
     ///////////////
-    // publishing
-    void    SendToDevice(pyVaultNode& node, const ST::string& deviceName);
-    ///////////////
     // yeesha pages, etc.
     PyObject* GetPsnlAgeSDL() const; // returns pySDLStateDataRecord
     void UpdatePsnlAgeSDL( pySDLStateDataRecord & rec );

Sources/Plasma/FeatureLib/pfPython/pyVaultGlue.cpp

@@ -228,25 +228,6 @@ PYTHON_METHOD_DEFINITION(ptVault, findNode, args)
     return self->fThis->FindNode(templateNode);
 }
 
-PYTHON_METHOD_DEFINITION(ptVault, sendToDevice, args)
-{
-    PyObject* nodeObj = nullptr;
-    ST::string deviceName;
-    if (!PyArg_ParseTuple(args, "OO&", &nodeObj, PyUnicode_STStringConverter, &deviceName))
-    {
-        PyErr_SetString(PyExc_TypeError, "sendToDevice expects a ptVaultNode and a string");
-        PYTHON_RETURN_ERROR;
-    }
-    if (!pyVaultNode::Check(nodeObj))
-    {
-        PyErr_SetString(PyExc_TypeError, "sendToDevice expects a ptVaultNode and a string");
-        PYTHON_RETURN_ERROR;
-    }
-    pyVaultNode* node = pyVaultNode::ConvertFrom(nodeObj);
-    self->fThis->SendToDevice(*node, deviceName);
-    PYTHON_RETURN_NONE;
-}
-
 PYTHON_METHOD_DEFINITION_NOARGS(ptVault, getPsnlAgeSDL)
 {
     return self->fThis->GetPsnlAgeSDL();
@@ -501,7 +482,6 @@ PYTHON_START_METHODS_TABLE(ptVault)
     PYTHON_BASIC_METHOD(ptVault, createGlobalInbox, "Creates the global inbox folder."),
 #endif
     PYTHON_METHOD(ptVault, findNode, "Params: templateNode\nFind the node matching the template"),
-    PYTHON_METHOD(ptVault, sendToDevice, "Params: node,deviceName\nSends a ptVaultNode object to an Age's device by deviceName."),
     PYTHON_METHOD_NOARGS(ptVault, getPsnlAgeSDL, "Returns the personal age SDL"),
     PYTHON_METHOD(ptVault, updatePsnlAgeSDL, "Params: pyrec\nUpdates the personal age SDL to the specified data"),
     PYTHON_METHOD_NOARGS(ptVault, inMyPersonalAge, "Are we in the player's personal age?"),

Sources/Plasma/FeatureLib/pfPython/pyVaultPlayerNode.cpp

@@ -198,7 +198,7 @@ void pyVaultPlayerNode::RemoveOwnedAgeLink(const ST::string& ageFilename)
 {
     plAgeInfoStruct info;
     info.SetAgeFilename(ageFilename);
-    VaultUnregisterOwnedAgeAndWait(&info);
+    VaultUnregisterOwnedAge(&info);
 }
 
 PyObject *pyVaultPlayerNode::GetVisitAgeLink(const pyAgeInfoStruct *info)
@@ -214,7 +214,7 @@ void pyVaultPlayerNode::RemoveVisitAgeLink(const ST::string& guidstr)
     plAgeInfoStruct info;
     plUUID guid(guidstr);
     info.SetAgeInstanceGuid(&guid);
-    VaultUnregisterOwnedAgeAndWait(&info);
+    VaultUnregisterOwnedAge(&info);
 }
 
 PyObject *pyVaultPlayerNode::FindChronicleEntry(const ST::string& entryName)