Skip to content

Close notice in Greengrass IPC client documentation #572

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion awsiot/greengrasscoreipc/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ def connect(*,
lifecycle_handler: Optional[LifecycleHandler]=None,
timeout: float=10.0) -> GreengrassCoreIPCClient:
"""
Creates an IPC client and connects to the GreengrassCoreIPC service.
Creates an IPC client and connects to the GreengrassCoreIPC service. When finished with the client,
you must call close() to free the client's native resources.

Args:
ipc_socket: Path to the Unix domain socket of Greengrass Nucleus, defaults to
Expand Down
5 changes: 4 additions & 1 deletion awsiot/greengrasscoreipc/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -1340,7 +1340,10 @@ def close(self): # type: (...) -> concurrent.futures.Future[None]

class GreengrassCoreIPCClient(rpc.Client):
"""
Client for the GreengrassCoreIPC service.
Client for the GreengrassCoreIPC service. When finished with the client,
you must call close() to free the client's native resources.


There is a new V2 client which should be preferred.
See the GreengrassCoreIPCClientV2 class in the clientv2 subpackage.

Expand Down
3 changes: 2 additions & 1 deletion awsiot/greengrasscoreipc/clientv2.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@

class GreengrassCoreIPCClientV2:
"""
V2 client for the GreengrassCoreIPC service.
V2 client for the GreengrassCoreIPC service. When finished with the client,
you must call close() to free the client's native resources.

Args:
client: Connection that this client will use. If you do not provide one, it will be made automatically.
Expand Down