Add is_closed() method to SSHClientConnection() and SSHServerConnecti…

…on()

This commit adds a new is_closed() method to test whether an existing
SSHClientConnection or SSHServerConnection object's network connection
is closed or not.

asyncssh/connection.py

@@ -1112,6 +1112,11 @@ def is_server(self) -> bool:
 
         return self._server
 
+    def is_closed(self):
+        """Return whether the connection is closed"""
+
+        return self._close_event.is_set()
+
     def get_owner(self) -> Optional[Union[SSHClient, SSHServer]]:
         """Return the SSHClient or SSHServer which owns this connection"""
 

docs/api.rst

@@ -334,6 +334,7 @@ SSHClientConnection
    .. automethod:: set_keepalive
    .. automethod:: get_server_host_key
    .. automethod:: send_debug
+   .. automethod:: is_closed
    =================================== =
 
    ====================================================================================================================================================== =
@@ -407,6 +408,7 @@ SSHServerConnection
    .. automethod:: set_extra_info
    .. automethod:: set_keepalive
    .. automethod:: send_debug
+   .. automethod:: is_closed
    ============================== =
 
    ============================================ =

tests/test_connection.py

@@ -381,9 +381,11 @@ async def _check_version(self, *args, **kwargs):
     async def test_connect(self):
         """Test connecting with async context manager"""
 
-        async with self.connect():
+        async with self.connect() as conn:
             pass
 
+        self.assertTrue(conn.is_closed())
+
     @asynctest
     async def test_connect_sock(self):
         """Test connecting using an already-connected socket"""