#include <GreengrassCoreIpcClient.h>

Public Member Functions
	GreengrassCoreIpcClient (Aws::Crt::Io::ClientBootstrap &clientBootstrap, Aws::Crt::Allocator *allocator=Aws::Crt::g_allocator) noexcept

std::future< RpcError >	Connect (ConnectionLifecycleHandler &lifecycleHandler, const ConnectionConfig &connectionConfig=DefaultConnectionConfig()) noexcept

bool	IsConnected () const noexcept

void	Close () noexcept

void	WithLaunchMode (std::launch mode) noexcept

std::shared_ptr< SubscribeToIoTCoreOperation >	NewSubscribeToIoTCore (std::shared_ptr< SubscribeToIoTCoreStreamHandler > streamHandler) noexcept

std::shared_ptr< ResumeComponentOperation >	NewResumeComponent () noexcept

std::shared_ptr< PublishToIoTCoreOperation >	NewPublishToIoTCore () noexcept

std::shared_ptr< SubscribeToConfigurationUpdateOperation >	NewSubscribeToConfigurationUpdate (std::shared_ptr< SubscribeToConfigurationUpdateStreamHandler > streamHandler) noexcept

std::shared_ptr< DeleteThingShadowOperation >	NewDeleteThingShadow () noexcept

std::shared_ptr< PutComponentMetricOperation >	NewPutComponentMetric () noexcept

std::shared_ptr< DeferComponentUpdateOperation >	NewDeferComponentUpdate () noexcept

std::shared_ptr< SubscribeToValidateConfigurationUpdatesOperation >	NewSubscribeToValidateConfigurationUpdates (std::shared_ptr< SubscribeToValidateConfigurationUpdatesStreamHandler > streamHandler) noexcept

std::shared_ptr< GetConfigurationOperation >	NewGetConfiguration () noexcept

std::shared_ptr< SubscribeToTopicOperation >	NewSubscribeToTopic (std::shared_ptr< SubscribeToTopicStreamHandler > streamHandler) noexcept

std::shared_ptr< GetComponentDetailsOperation >	NewGetComponentDetails () noexcept

std::shared_ptr< GetClientDeviceAuthTokenOperation >	NewGetClientDeviceAuthToken () noexcept

std::shared_ptr< PublishToTopicOperation >	NewPublishToTopic () noexcept

std::shared_ptr< SubscribeToCertificateUpdatesOperation >	NewSubscribeToCertificateUpdates (std::shared_ptr< SubscribeToCertificateUpdatesStreamHandler > streamHandler) noexcept

std::shared_ptr< VerifyClientDeviceIdentityOperation >	NewVerifyClientDeviceIdentity () noexcept

std::shared_ptr< AuthorizeClientDeviceActionOperation >	NewAuthorizeClientDeviceAction () noexcept

std::shared_ptr< ListComponentsOperation >	NewListComponents () noexcept

std::shared_ptr< CreateDebugPasswordOperation >	NewCreateDebugPassword () noexcept

std::shared_ptr< GetThingShadowOperation >	NewGetThingShadow () noexcept

std::shared_ptr< SendConfigurationValidityReportOperation >	NewSendConfigurationValidityReport () noexcept

std::shared_ptr< UpdateThingShadowOperation >	NewUpdateThingShadow () noexcept

std::shared_ptr< UpdateConfigurationOperation >	NewUpdateConfiguration () noexcept

std::shared_ptr< ValidateAuthorizationTokenOperation >	NewValidateAuthorizationToken () noexcept

std::shared_ptr< RestartComponentOperation >	NewRestartComponent () noexcept

std::shared_ptr< GetLocalDeploymentStatusOperation >	NewGetLocalDeploymentStatus () noexcept

std::shared_ptr< GetSecretValueOperation >	NewGetSecretValue () noexcept

std::shared_ptr< UpdateStateOperation >	NewUpdateState () noexcept

std::shared_ptr< CancelLocalDeploymentOperation >	NewCancelLocalDeployment () noexcept

std::shared_ptr< ListNamedShadowsForThingOperation >	NewListNamedShadowsForThing () noexcept

std::shared_ptr< SubscribeToComponentUpdatesOperation >	NewSubscribeToComponentUpdates (std::shared_ptr< SubscribeToComponentUpdatesStreamHandler > streamHandler) noexcept

std::shared_ptr< ListLocalDeploymentsOperation >	NewListLocalDeployments () noexcept

std::shared_ptr< StopComponentOperation >	NewStopComponent () noexcept

std::shared_ptr< PauseComponentOperation >	NewPauseComponent () noexcept

std::shared_ptr< CreateLocalDeploymentOperation >	NewCreateLocalDeployment () noexcept

	~GreengrassCoreIpcClient () noexcept

Constructor & Destructor Documentation

◆ GreengrassCoreIpcClient()

Aws::Greengrass::GreengrassCoreIpcClient::GreengrassCoreIpcClient	(	Aws::Crt::Io::ClientBootstrap &	clientBootstrap,
		Aws::Crt::Allocator *	allocator = `Aws::Crt::g_allocator`
	)

noexcept

◆ ~GreengrassCoreIpcClient()

Aws::Greengrass::GreengrassCoreIpcClient::~GreengrassCoreIpcClient ( )

noexcept

Member Function Documentation

◆ Close()

void Aws::Greengrass::GreengrassCoreIpcClient::Close ( )

noexcept

◆ Connect()

std::future< RpcError > Aws::Greengrass::GreengrassCoreIpcClient::Connect	(	ConnectionLifecycleHandler &	lifecycleHandler,
		const ConnectionConfig &	connectionConfig = `DefaultConnectionConfig()`
	)

noexcept

Connect the client to the server

Parameters

lifecycleHandler	An interface that is called upon when lifecycle events relating to the connection occur.
connectionConfig	The configuration parameters used for establishing the connection.

Returns: An RpcError that can be used to check whether the connection was established.

◆ IsConnected()

bool Aws::Greengrass::GreengrassCoreIpcClient::IsConnected ( ) const

inlinenoexcept

◆ NewAuthorizeClientDeviceAction()

std::shared_ptr< AuthorizeClientDeviceActionOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewAuthorizeClientDeviceAction ( )

noexcept

Send a request to authorize action on some resource

◆ NewCancelLocalDeployment()

std::shared_ptr< CancelLocalDeploymentOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewCancelLocalDeployment ( )

noexcept

Cancel a local deployment on the device.

◆ NewCreateDebugPassword()

std::shared_ptr< CreateDebugPasswordOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewCreateDebugPassword ( )

noexcept

Generate a password for the LocalDebugConsole component

◆ NewCreateLocalDeployment()

std::shared_ptr< CreateLocalDeploymentOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewCreateLocalDeployment ( )

noexcept

Creates a local deployment on the device. Also allows to remove existing components.

◆ NewDeferComponentUpdate()

std::shared_ptr< DeferComponentUpdateOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewDeferComponentUpdate ( )

noexcept

Defer the update of components by a given amount of time and check again after that.

◆ NewDeleteThingShadow()

std::shared_ptr< DeleteThingShadowOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewDeleteThingShadow ( )

noexcept

Deletes a device shadow document stored in the local shadow service

◆ NewGetClientDeviceAuthToken()

std::shared_ptr< GetClientDeviceAuthTokenOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewGetClientDeviceAuthToken ( )

noexcept

Get session token for a client device

◆ NewGetComponentDetails()

std::shared_ptr< GetComponentDetailsOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewGetComponentDetails ( )

noexcept

Gets the status and version of the component with the given component name

◆ NewGetConfiguration()

std::shared_ptr< GetConfigurationOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewGetConfiguration ( )

noexcept

Get value of a given key from the configuration

◆ NewGetLocalDeploymentStatus()

std::shared_ptr< GetLocalDeploymentStatusOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewGetLocalDeploymentStatus ( )

noexcept

Get status of a local deployment with the given deploymentId

◆ NewGetSecretValue()

std::shared_ptr< GetSecretValueOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewGetSecretValue ( )

noexcept

Retrieves a secret stored in AWS secrets manager

◆ NewGetThingShadow()

std::shared_ptr< GetThingShadowOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewGetThingShadow ( )

noexcept

Retrieves a device shadow document stored by the local shadow service

◆ NewListComponents()

std::shared_ptr< ListComponentsOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewListComponents ( )

noexcept

Request for a list of components

◆ NewListLocalDeployments()

std::shared_ptr< ListLocalDeploymentsOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewListLocalDeployments ( )

noexcept

Lists the last 5 local deployments along with their statuses

◆ NewListNamedShadowsForThing()

std::shared_ptr< ListNamedShadowsForThingOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewListNamedShadowsForThing ( )

noexcept

Lists the named shadows for the specified thing

◆ NewPauseComponent()

std::shared_ptr< PauseComponentOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewPauseComponent ( )

noexcept

Pause a running component

◆ NewPublishToIoTCore()

std::shared_ptr< PublishToIoTCoreOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewPublishToIoTCore ( )

noexcept

Publish an MQTT message to AWS IoT message broker

◆ NewPublishToTopic()

std::shared_ptr< PublishToTopicOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewPublishToTopic ( )

noexcept

Publish to a custom topic.

◆ NewPutComponentMetric()

std::shared_ptr< PutComponentMetricOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewPutComponentMetric ( )

noexcept

Send component metrics NOTE Only usable by AWS components

◆ NewRestartComponent()

std::shared_ptr< RestartComponentOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewRestartComponent ( )

noexcept

Restarts a component with the given name

◆ NewResumeComponent()

std::shared_ptr< ResumeComponentOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewResumeComponent ( )

noexcept

Resume a paused component

◆ NewSendConfigurationValidityReport()

std::shared_ptr< SendConfigurationValidityReportOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewSendConfigurationValidityReport ( )

noexcept

This operation should be used in response to event received as part of SubscribeToValidateConfigurationUpdates subscription. It is not necessary to send the report if the configuration is valid (GGC will wait for timeout period and proceed). Sending the report with invalid config status will prevent GGC from applying the updates

◆ NewStopComponent()

std::shared_ptr< StopComponentOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewStopComponent ( )

noexcept

Stops a component with the given name

◆ NewSubscribeToCertificateUpdates()

std::shared_ptr< SubscribeToCertificateUpdatesOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewSubscribeToCertificateUpdates ( std::shared_ptr< SubscribeToCertificateUpdatesStreamHandler > streamHandler )

noexcept

Create a subscription for new certificates

◆ NewSubscribeToComponentUpdates()

std::shared_ptr< SubscribeToComponentUpdatesOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewSubscribeToComponentUpdates ( std::shared_ptr< SubscribeToComponentUpdatesStreamHandler > streamHandler )

noexcept

Subscribe to receive notification if GGC is about to update any components

◆ NewSubscribeToConfigurationUpdate()

std::shared_ptr< SubscribeToConfigurationUpdateOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewSubscribeToConfigurationUpdate ( std::shared_ptr< SubscribeToConfigurationUpdateStreamHandler > streamHandler )

noexcept

Subscribes to be notified when GGC updates the configuration for a given componentName and keyName.

◆ NewSubscribeToIoTCore()

std::shared_ptr< SubscribeToIoTCoreOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewSubscribeToIoTCore ( std::shared_ptr< SubscribeToIoTCoreStreamHandler > streamHandler )

noexcept

Subscribe to a topic in AWS IoT message broker.

◆ NewSubscribeToTopic()

std::shared_ptr< SubscribeToTopicOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewSubscribeToTopic ( std::shared_ptr< SubscribeToTopicStreamHandler > streamHandler )

noexcept

Creates a subscription for a custom topic

◆ NewSubscribeToValidateConfigurationUpdates()

std::shared_ptr< SubscribeToValidateConfigurationUpdatesOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewSubscribeToValidateConfigurationUpdates ( std::shared_ptr< SubscribeToValidateConfigurationUpdatesStreamHandler > streamHandler )

noexcept

Subscribes to be notified when GGC is about to update configuration for this component GGC will wait for a timeout period before it proceeds with the update. If the new configuration is not valid this component can use the SendConfigurationValidityReport operation to indicate that

◆ NewUpdateConfiguration()

std::shared_ptr< UpdateConfigurationOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewUpdateConfiguration ( )

noexcept

Update this component's configuration by replacing the value of given keyName with the newValue. If an oldValue is specified then update will only take effect id the current value matches the given oldValue

◆ NewUpdateState()

std::shared_ptr< UpdateStateOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewUpdateState ( )

noexcept

Update status of this component

◆ NewUpdateThingShadow()

std::shared_ptr< UpdateThingShadowOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewUpdateThingShadow ( )

noexcept

Updates a device shadow document stored in the local shadow service The update is an upsert operation, with optimistic locking support

◆ NewValidateAuthorizationToken()

std::shared_ptr< ValidateAuthorizationTokenOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewValidateAuthorizationToken ( )

noexcept

Validate authorization token NOTE This API can be used only by stream manager, customer component calling this API will receive UnauthorizedError

◆ NewVerifyClientDeviceIdentity()

std::shared_ptr< VerifyClientDeviceIdentityOperation > Aws::Greengrass::GreengrassCoreIpcClient::NewVerifyClientDeviceIdentity ( )

noexcept

Verify client device credentials

◆ WithLaunchMode()

void Aws::Greengrass::GreengrassCoreIpcClient::WithLaunchMode ( std::launch mode )

noexcept

The documentation for this class was generated from the following files:

greengrass_ipc/include/aws/greengrass/GreengrassCoreIpcClient.h
greengrass_ipc/source/GreengrassCoreIpcClient.cpp

Public Member Functions

Constructor & Destructor Documentation

◆ GreengrassCoreIpcClient()

◆ ~GreengrassCoreIpcClient()

Member Function Documentation

◆ Close()

◆ Connect()

◆ IsConnected()

◆ NewAuthorizeClientDeviceAction()

◆ NewCancelLocalDeployment()

◆ NewCreateDebugPassword()

◆ NewCreateLocalDeployment()

◆ NewDeferComponentUpdate()

◆ NewDeleteThingShadow()

◆ NewGetClientDeviceAuthToken()

◆ NewGetComponentDetails()

◆ NewGetConfiguration()

◆ NewGetLocalDeploymentStatus()

◆ NewGetSecretValue()

◆ NewGetThingShadow()

◆ NewListComponents()

◆ NewListLocalDeployments()

◆ NewListNamedShadowsForThing()

◆ NewPauseComponent()

◆ NewPublishToIoTCore()

◆ NewPublishToTopic()

◆ NewPutComponentMetric()

◆ NewRestartComponent()

◆ NewResumeComponent()

◆ NewSendConfigurationValidityReport()

◆ NewStopComponent()

◆ NewSubscribeToCertificateUpdates()

◆ NewSubscribeToComponentUpdates()

◆ NewSubscribeToConfigurationUpdate()

◆ NewSubscribeToIoTCore()

◆ NewSubscribeToTopic()

◆ NewSubscribeToValidateConfigurationUpdates()

◆ NewUpdateConfiguration()

◆ NewUpdateState()

◆ NewUpdateThingShadow()

◆ NewValidateAuthorizationToken()

◆ NewVerifyClientDeviceIdentity()

◆ WithLaunchMode()