feat: updated R session interface

Author: ymarcon

datashield/api.py

@@ -199,7 +199,7 @@ def profiles(self) -> dict:
     def packages(self) -> dict:
         """
         Get the list of DataSHIELD packages with their version, that have been configured on the remote data repository.
-        
+
         :return: The list of DataSHIELD packages with their version, that have been configured on the remote data repository, per remote server name
         """
         rval = {}
@@ -227,7 +227,7 @@ def workspaces(self) -> dict:
         """
         Get the list of DataSHIELD workspaces, that have been saved on the remote data repository.
 
-        :return: The list of DataSHIELD workspaces, that have been saved on the remote data repository, per remote server name  
+        :return: The list of DataSHIELD workspaces, that have been saved on the remote data repository, per remote server name
         """
         rval = {}
         for conn in self.conns:
@@ -294,7 +294,7 @@ def sessions(self) -> dict:
     def ls(self) -> dict:
         """
         After assignments have been performed, list the symbols that live in the DataSHIELD R session on the server side.
-        
+
         :return: The symbols that live in the DataSHIELD R session on the server side, per remote server name
         """
         self._init_errors()

datashield/interface.py

@@ -63,21 +63,33 @@ class RSession:
     R Session (server side) class to a DataSHIELD server.
     """
 
+    def is_started(self) -> bool:
+        """
+        Get whether the session has been started. This call must not wait for the session to
+        be started, immediate response is expected.
+
+        :return: Whether the session has been started
+        """
+        raise NotImplementedError("RSession function not available")
+
     def is_ready(self) -> bool:
         """
         Get whether the session is ready for receiving requests. This call must not
         wait for the session to be ready, immediate response is expected.
 
         :return: Whether the session is ready
+        :throws: DSError if the session was not started or session information is not available
         """
         raise NotImplementedError("RSession function not available")
 
     def is_pending(self) -> bool:
         """
-        Get whether the session is pending, i.e., it is in the process of being started but is not ready yet. This call must not
-        wait for the session to be pending, immediate response is expected.
+        Get whether the session is pending, i.e., it is in the process of being started but is
+        not ready yet. This call must not wait for the session to be pending, immediate response
+        is expected.
 
         :return: Whether the session is pending
+        :throws: DSError if the session was not started or session information is not available
         """
         raise NotImplementedError("RSession function not available")
 
@@ -87,14 +99,26 @@ def is_failed(self) -> bool:
         wait for the session to have failed, immediate response is expected.
 
         :return: Whether the session has failed
+        :throws: DSError if the session was not started or session information is not available
+        """
+        raise NotImplementedError("RSession function not available")
+
+    def is_terminated(self) -> bool:
+        """
+        Get whether the session is terminated. This call must not wait for the session to be
+        terminated, immediate response is expected.
+
+        :return: Whether the session is terminated
+        :throws: DSError if the session was not started or session information is not available
         """
         raise NotImplementedError("RSession function not available")
 
-    def get_state_message(self) -> str:
+    def get_last_message(self) -> str:
         """
         Get a message describing the current state of the session, which can be used for debugging or logging purposes.
 
         :return: The session state message
+        :throws: DSError if the session was not started or session information is not available
         """
         raise NotImplementedError("RSession function not available")