Public Member Functions
	AZ_RTTI (IRemoteTools, "{1446BADE-E6F7-4E3C-8D37-669A544DB964}")

virtual void	RegisterToolingServiceClient (AZ::Crc32 key, AZ::Name name, uint16_t port)=0

virtual void	RegisterToolingServiceHost (AZ::Crc32 key, AZ::Name name, uint16_t port)=0

virtual const ReceivedRemoteToolsMessages *	GetReceivedMessages (AZ::Crc32 key) const =0

virtual void	ClearReceivedMessages (AZ::Crc32 key)=0

virtual void	RegisterRemoteToolsEndpointJoinedHandler (AZ::Crc32 key, RemoteToolsEndpointStatusEvent::Handler &handler)=0

virtual void	RegisterRemoteToolsEndpointLeftHandler (AZ::Crc32 key, RemoteToolsEndpointStatusEvent::Handler &handler)=0

virtual void	RegisterRemoteToolsEndpointConnectedHandler (AZ::Crc32 key, RemoteToolsEndpointConnectedEvent::Handler &handler)=0

virtual void	RegisterRemoteToolsEndpointChangedHandler (AZ::Crc32 key, RemoteToolsEndpointChangedEvent::Handler &handler)=0

virtual void	EnumTargetInfos (AZ::Crc32 key, RemoteToolsEndpointContainer &infos)=0

virtual void	SetDesiredEndpoint (AZ::Crc32 key, AZ::u32 desiredTargetID)=0

virtual void	SetDesiredEndpointInfo (AZ::Crc32 key, const RemoteToolsEndpointInfo &targetInfo)=0

virtual RemoteToolsEndpointInfo	GetDesiredEndpoint (AZ::Crc32 key)=0

virtual RemoteToolsEndpointInfo	GetEndpointInfo (AZ::Crc32 key, AZ::u32 desiredTargetID)=0

virtual bool	IsEndpointOnline (AZ::Crc32 key, AZ::u32 desiredTargetID)=0

virtual void	SendRemoteToolsMessage (const RemoteToolsEndpointInfo &target, const RemoteToolsMessage &msg)=0

Member Function Documentation

◆ ClearReceivedMessages()

virtual void AzFramework::IRemoteTools::ClearReceivedMessages ( AZ::Crc32 key )

pure virtual

Clears pending received messages for a given Remote Tools Service. Useful for situations in which messages must be processed out of band.

Parameters

key	The key of the service to clear messages for

◆ EnumTargetInfos()

virtual void AzFramework::IRemoteTools::EnumTargetInfos	(	AZ::Crc32	key,
		RemoteToolsEndpointContainer &	infos
	)

pure virtual

Retrieves a list of currently known endpoints for a given service, useful for GUI

Parameters

key	The key fo the service to fetch endpoints for
infos	Out param of endpoint infos

◆ GetDesiredEndpoint()

virtual RemoteToolsEndpointInfo AzFramework::IRemoteTools::GetDesiredEndpoint ( AZ::Crc32 key )

pure virtual

Get the desired endpoint info for a given service

Parameters

key	The key of the service to get the desired endpoint of

Returns: The info of the desired endpoint

◆ GetEndpointInfo()

virtual RemoteToolsEndpointInfo AzFramework::IRemoteTools::GetEndpointInfo	(	AZ::Crc32	key,
		AZ::u32	desiredTargetID
	)

pure virtual

Get the endpoint info for a given service of a given id

Parameters

key	The key of the service to get the desired endpoint of
desiredTargetID	The ID of the endpoint to fetch info for

Returns: The info of the desired endpoint

◆ GetReceivedMessages()

virtual const ReceivedRemoteToolsMessages * AzFramework::IRemoteTools::GetReceivedMessages ( AZ::Crc32 key ) const

pure virtual

Gets pending received messages for a given Remote Tools Service

Parameters

key	The key of the service to retrieve messages for

Returns: A vector of received messages pending processing for the given service

◆ IsEndpointOnline()

virtual bool AzFramework::IRemoteTools::IsEndpointOnline	(	AZ::Crc32	key,
		AZ::u32	desiredTargetID
	)

pure virtual

Check if target is online

Parameters

key	The key of the service to check the endpoint of
desiredTargetID	The ID of the endpoint to check

Returns: true if the endpoint is online

◆ RegisterToolingServiceClient()

virtual void AzFramework::IRemoteTools::RegisterToolingServiceClient	(	AZ::Crc32	key,
		AZ::Name	name,
		uint16_t	port
	)

pure virtual

Registers the application as a client of a Remote Tools service with a pre-defined key, name and target port

Parameters

key	A Crc32 key used to identify this service
name	The string name of this service
port	The port on which this service connects

◆ RegisterToolingServiceHost()

virtual void AzFramework::IRemoteTools::RegisterToolingServiceHost	(	AZ::Crc32	key,
		AZ::Name	name,
		uint16_t	port
	)

pure virtual

Registers the application as a host of a Remote Tools service with a pre-defined key, name and target port

Parameters

key	A Crc32 key used to identify this service
name	The string name of this service
port	The port on which this service starts listening on registration

◆ SendRemoteToolsMessage()

virtual void AzFramework::IRemoteTools::SendRemoteToolsMessage	(	const RemoteToolsEndpointInfo &	target,
		const RemoteToolsMessage &	msg
	)

pure virtual

Send a message to a remote endpoint

Parameters

target	The endpoint to send a message to
msg	The message to send

◆ SetDesiredEndpoint()

virtual void AzFramework::IRemoteTools::SetDesiredEndpoint	(	AZ::Crc32	key,
		AZ::u32	desiredTargetID
	)

pure virtual

Set the desired endpoint for a given service

Parameters

key	The key of the service to set desired endpoint on
desiredTargetID	The ID of the endpoint to set as targeted

◆ SetDesiredEndpointInfo()

virtual void AzFramework::IRemoteTools::SetDesiredEndpointInfo	(	AZ::Crc32	key,
		const RemoteToolsEndpointInfo &	targetInfo
	)

pure virtual

Set the desired endpoint info for a given service

Parameters

key	The key of the service to set desired endpoint on
targetInfo	The info to set for the desired endpoint

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

Code/Framework/AzFramework/AzFramework/Network/IRemoteTools.h

Public Member Functions

Member Function Documentation

◆ ClearReceivedMessages()

◆ EnumTargetInfos()

◆ GetDesiredEndpoint()

◆ GetEndpointInfo()

◆ GetReceivedMessages()

◆ IsEndpointOnline()

◆ RegisterToolingServiceClient()

◆ RegisterToolingServiceHost()

◆ SendRemoteToolsMessage()

◆ SetDesiredEndpoint()

◆ SetDesiredEndpointInfo()