Stores the settings needed to make a connection either to or from an AssetProcessor instance. More...

#include <AssetSystemBus.h>

Public Types
enum class	ConnectionDirection : AZ::s64 { ListenForConnectFromAssetProcessor , ConnectToAssetProcessor }

using	LoggingCallback = AZStd::function< void(AZStd::string_view)>

Public Attributes
AZStd::fixed_string< 64 >	m_projectName

AZStd::fixed_string< 32 >	m_assetProcessorIp { "127.0.0.1" }

AZStd::fixed_string< 32 >	m_branchToken

AZStd::fixed_string< 32 >	m_connectionIdentifier
	The identifier that will be used for negotiating a connection with the AssetProcessor.

AZStd::fixed_string< 32 >	m_assetPlatform { "pc" }

ConnectionDirection	m_connectionDirection { ConnectionDirection::ConnectToAssetProcessor }

AZ::u16	m_assetProcessorPort { 45643 }

AZStd::chrono::duration< float >	m_connectTimeout { 3.0f }

AZStd::chrono::duration< float >	m_launchTimeout { 15.0f }

AZStd::chrono::duration< float >	m_waitForReadyTimeout { 1200.0f }

LoggingCallback	m_loggingCallback

bool	m_launchAssetProcessorOnFailedConnection { true }
	Attempt to Launch the AssetProcessor if connection fails.

bool	m_waitUntilAssetProcessorIsReady { true }

bool	m_waitForConnect {}

Detailed Description

Stores the settings needed to make a connection either to or from an AssetProcessor instance.

Member Data Documentation

◆ m_assetPlatform

AZStd::fixed_string<32> AzFramework::AssetSystem::ConnectionSettings::m_assetPlatform { "pc" }

The asset platform to use when negotiating a connection with the Asset Processor (Can be queried from Settings Registry - "assets")

◆ m_assetProcessorIp

AZStd::fixed_string<32> AzFramework::AssetSystem::ConnectionSettings::m_assetProcessorIp { "127.0.0.1" }

The IP address to use either connect to or from the AssetProcessor (Can be queried from Settings Registry - "remote_ip")

◆ m_assetProcessorPort

AZ::u16 AzFramework::AssetSystem::ConnectionSettings::m_assetProcessorPort { 45643 }

The port number to use either connect to or from the AssetProcessor (Can be queried from Settings Registry - "remote_port")

◆ m_branchToken

AZStd::fixed_string<32> AzFramework::AssetSystem::ConnectionSettings::m_branchToken

The token used to indicate the application is attempting to connect to an AssetProcessor That was built from the same code branch (Can be queried from Settings Registry - "assetProcessor_branch_token")

◆ m_connectionDirection

ConnectionDirection AzFramework::AssetSystem::ConnectionSettings::m_connectionDirection { ConnectionDirection::ConnectToAssetProcessor }

Determines if the connection should either be to the AssetProcessor from this application or if this application should listen for a connection from the AssetProcessor (Can be queried from Settings Registry - "connect_to_remote")

◆ m_connectTimeout

AZStd::chrono::duration<float> AzFramework::AssetSystem::ConnectionSettings::m_connectTimeout { 3.0f }

Timeout(units: seconds) to use when either connecting to an already launched AssetProcessor or listening for a connection from the AssetProcessor Defaults to 3 seconds (Can be queried from Settings Registry - "connect_ap_timeout")

◆ m_launchTimeout

AZStd::chrono::duration<float> AzFramework::AssetSystem::ConnectionSettings::m_launchTimeout { 15.0f }

Timeout(units: seconds) to use when launching a new instance of the AssetProcessor and attempting to connect to that instance Defaults to 15 seconds (Can be queried from Settings Registry - "launch_ap_timeout")

◆ m_projectName

AZStd::fixed_string<64> AzFramework::AssetSystem::ConnectionSettings::m_projectName

Name of the game project that is used for negotiating a connection with the AssetProcessor The AssetProcessor needs to be processing Assets for the specified game project (Can be queried from Settings Registry - "project_name" under the ProjectSettingsRootKey)

◆ m_waitForConnect

bool AzFramework::AssetSystem::ConnectionSettings::m_waitForConnect {}

If set the connection call will attempt to wait indefinitely until the AssetProcessor sends back a failed negotiation message (Can be queried from Settings Registry - "wait_for_connect")

◆ m_waitForReadyTimeout

AZStd::chrono::duration<float> AzFramework::AssetSystem::ConnectionSettings::m_waitForReadyTimeout { 1200.0f }

Timeout(units: seconds) that indicates how long to wait for the AssetProcessor to indicate it is ready after successfully connecting The AssetProcessor isn't ready until it processes all critical Assets so this timeout should be adjusted based on myriad of factors i.e How many critical assets a project contains? Are the critical assets being processed using debug AssetBuilders etc... Defaults to 20 minutes (Can be queried from Settings Registry - "wait_ap_ready_timeout")

◆ m_waitUntilAssetProcessorIsReady

bool AzFramework::AssetSystem::ConnectionSettings::m_waitUntilAssetProcessorIsReady { true }

Indicates whether to wait until the AssetProcessor sends a response that it is ready if a connection has been established

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

Code/Framework/AzFramework/AzFramework/Asset/AssetSystemBus.h

Public Types

Public Attributes