Skip to content

Commit 29fdb46

Browse files
authored
Close notice in Greengrass IPC client documentation (#572)
* Close notice in client documentation
1 parent 5683a80 commit 29fdb46

File tree

3 files changed

+8
-3
lines changed

3 files changed

+8
-3
lines changed

awsiot/greengrasscoreipc/__init__.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ def connect(*,
2525
lifecycle_handler: Optional[LifecycleHandler]=None,
2626
timeout: float=10.0) -> GreengrassCoreIPCClient:
2727
"""
28-
Creates an IPC client and connects to the GreengrassCoreIPC service.
28+
Creates an IPC client and connects to the GreengrassCoreIPC service. When finished with the client,
29+
you must call close() to free the client's native resources.
2930
3031
Args:
3132
ipc_socket: Path to the Unix domain socket of Greengrass Nucleus, defaults to

awsiot/greengrasscoreipc/client.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1340,7 +1340,10 @@ def close(self): # type: (...) -> concurrent.futures.Future[None]
13401340

13411341
class GreengrassCoreIPCClient(rpc.Client):
13421342
"""
1343-
Client for the GreengrassCoreIPC service.
1343+
Client for the GreengrassCoreIPC service. When finished with the client,
1344+
you must call close() to free the client's native resources.
1345+
1346+
13441347
There is a new V2 client which should be preferred.
13451348
See the GreengrassCoreIPCClientV2 class in the clientv2 subpackage.
13461349

awsiot/greengrasscoreipc/clientv2.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@
1414

1515
class GreengrassCoreIPCClientV2:
1616
"""
17-
V2 client for the GreengrassCoreIPC service.
17+
V2 client for the GreengrassCoreIPC service. When finished with the client,
18+
you must call close() to free the client's native resources.
1819
1920
Args:
2021
client: Connection that this client will use. If you do not provide one, it will be made automatically.

0 commit comments

Comments
 (0)