AzFramework::AssetSystem::BaseAssetProcessorMessage Class Reference

Inherited by AzFramework::AssetSystem::AssetChangeReportRequest, AzFramework::AssetSystem::AssetChangeReportResponse, AzFramework::AssetSystem::AssetDependencyInfoRequest, AzFramework::AssetSystem::AssetDependencyInfoResponse, AzFramework::AssetSystem::AssetInfoRequest, AzFramework::AssetSystem::AssetInfoResponse, AzFramework::AssetSystem::AssetNotificationMessage, AzFramework::AssetSystem::BulkAssetNotificationMessage, AzFramework::AssetSystem::FileCloseRequest, AzFramework::AssetSystem::FileCopyRequest, AzFramework::AssetSystem::FileCopyResponse, AzFramework::AssetSystem::FileExistsRequest, AzFramework::AssetSystem::FileExistsResponse, AzFramework::AssetSystem::FileFlushRequest, AzFramework::AssetSystem::FileFlushResponse, AzFramework::AssetSystem::FileIsReadOnlyRequest, AzFramework::AssetSystem::FileIsReadOnlyResponse, AzFramework::AssetSystem::FileModTimeRequest, AzFramework::AssetSystem::FileModTimeResponse, AzFramework::AssetSystem::FileOpenRequest, AzFramework::AssetSystem::FileOpenResponse, AzFramework::AssetSystem::FileReadRequest, AzFramework::AssetSystem::FileReadResponse, AzFramework::AssetSystem::FileRemoveRequest, AzFramework::AssetSystem::FileRemoveResponse, AzFramework::AssetSystem::FileRenameRequest, AzFramework::AssetSystem::FileRenameResponse, AzFramework::AssetSystem::FileSeekRequest, AzFramework::AssetSystem::FileSeekResponse, AzFramework::AssetSystem::FileSizeRequest, AzFramework::AssetSystem::FileSizeResponse, AzFramework::AssetSystem::FileTellRequest, AzFramework::AssetSystem::FileTellResponse, AzFramework::AssetSystem::FileTreeRequest, AzFramework::AssetSystem::FileTreeResponse, AzFramework::AssetSystem::FileWriteRequest, AzFramework::AssetSystem::FileWriteResponse, AzFramework::AssetSystem::FindFilesRequest, AzFramework::AssetSystem::FindFilesResponse, AzFramework::AssetSystem::GenerateRelativeSourcePathRequest, AzFramework::AssetSystem::GenerateRelativeSourcePathResponse, AzFramework::AssetSystem::GetFullSourcePathFromRelativeProductPathRequest, AzFramework::AssetSystem::GetFullSourcePathFromRelativeProductPathResponse, AzFramework::AssetSystem::GetRelativeProductPathFromFullSourceOrProductPathRequest, AzFramework::AssetSystem::GetRelativeProductPathFromFullSourceOrProductPathResponse, AzFramework::AssetSystem::GetUnresolvedDependencyCountsRequest, AzFramework::AssetSystem::GetUnresolvedDependencyCountsResponse, AzFramework::AssetSystem::NegotiationMessage, AzFramework::AssetSystem::PathCreateRequest, AzFramework::AssetSystem::PathCreateResponse, AzFramework::AssetSystem::PathDestroyRequest, AzFramework::AssetSystem::PathDestroyResponse, AzFramework::AssetSystem::PathIsDirectoryRequest, AzFramework::AssetSystem::PathIsDirectoryResponse, AzFramework::AssetSystem::RegisterSourceAssetRequest, AzFramework::AssetSystem::RequestAssetProcessorStatus, AzFramework::AssetSystem::RequestAssetStatus, AzFramework::AssetSystem::RequestEscalateAsset, AzFramework::AssetSystem::RequestPing, AzFramework::AssetSystem::ResponseAssetProcessorStatus, AzFramework::AssetSystem::ResponseAssetStatus, AzFramework::AssetSystem::ResponsePing, AzFramework::AssetSystem::SaveAssetCatalogRequest, AzFramework::AssetSystem::SaveAssetCatalogResponse, AzFramework::AssetSystem::ShowAssetInAssetProcessorRequest, AzFramework::AssetSystem::ShowAssetProcessorRequest, AzFramework::AssetSystem::SourceAssetInfoRequest, AzFramework::AssetSystem::SourceAssetInfoResponse, and AzFramework::AssetSystem::UnregisterSourceAssetRequest.

Public Member Functions
	AZ_RTTI (BaseAssetProcessorMessage, "{366A7093-C57B-4514-A1BD-A6437AEF2098}")
	BaseAssetProcessorMessage (bool requireFencing=false)
virtual unsigned int	GetMessageType () const =0
	The id of the message type, an unsigned int which can be used to identify which message it is.
bool	RequireFencing () const

Static Public Member Functions
static void	Reflect (AZ::ReflectContext *context)

Member Function Documentation

GetMessageType()

virtual unsigned int AzFramework::AssetSystem::BaseAssetProcessorMessage::GetMessageType ( ) const

pure virtual

The id of the message type, an unsigned int which can be used to identify which message it is.

Implemented in AzFramework::AssetSystem::NegotiationMessage, AzFramework::AssetSystem::RequestPing, AzFramework::AssetSystem::ResponsePing, AzFramework::AssetSystem::RequestAssetStatus, AzFramework::AssetSystem::ResponseAssetStatus, AzFramework::AssetSystem::RequestEscalateAsset, AzFramework::AssetSystem::RequestAssetProcessorStatus, AzFramework::AssetSystem::ResponseAssetProcessorStatus, AzFramework::AssetSystem::GetUnresolvedDependencyCountsRequest, AzFramework::AssetSystem::GetUnresolvedDependencyCountsResponse, AzFramework::AssetSystem::GetRelativeProductPathFromFullSourceOrProductPathRequest, AzFramework::AssetSystem::GetRelativeProductPathFromFullSourceOrProductPathResponse, AzFramework::AssetSystem::GenerateRelativeSourcePathRequest, AzFramework::AssetSystem::GenerateRelativeSourcePathResponse, AzFramework::AssetSystem::GetFullSourcePathFromRelativeProductPathRequest, AzFramework::AssetSystem::GetFullSourcePathFromRelativeProductPathResponse, AzFramework::AssetSystem::SourceAssetInfoRequest, AzFramework::AssetSystem::SourceAssetInfoResponse, AzFramework::AssetSystem::AssetInfoRequest, AzFramework::AssetSystem::AssetInfoResponse, AzFramework::AssetSystem::AssetDependencyInfoRequest, AzFramework::AssetSystem::AssetDependencyInfoResponse, AzFramework::AssetSystem::RegisterSourceAssetRequest, AzFramework::AssetSystem::UnregisterSourceAssetRequest, AzFramework::AssetSystem::ShowAssetProcessorRequest, AzFramework::AssetSystem::ShowAssetInAssetProcessorRequest, AzFramework::AssetSystem::AssetNotificationMessage, AzFramework::AssetSystem::BulkAssetNotificationMessage, AzFramework::AssetSystem::SaveAssetCatalogRequest, AzFramework::AssetSystem::SaveAssetCatalogResponse, AzFramework::AssetSystem::FileOpenRequest, AzFramework::AssetSystem::FileOpenResponse, AzFramework::AssetSystem::FileCloseRequest, AzFramework::AssetSystem::FileReadRequest, AzFramework::AssetSystem::FileReadResponse, AzFramework::AssetSystem::FileWriteRequest, AzFramework::AssetSystem::FileWriteResponse, AzFramework::AssetSystem::FileTellRequest, AzFramework::AssetSystem::FileTellResponse, AzFramework::AssetSystem::FileSeekRequest, AzFramework::AssetSystem::FileSeekResponse, AzFramework::AssetSystem::FileIsReadOnlyRequest, AzFramework::AssetSystem::FileIsReadOnlyResponse, AzFramework::AssetSystem::PathIsDirectoryRequest, AzFramework::AssetSystem::PathIsDirectoryResponse, AzFramework::AssetSystem::FileSizeRequest, AzFramework::AssetSystem::FileSizeResponse, AzFramework::AssetSystem::FileModTimeRequest, AzFramework::AssetSystem::FileModTimeResponse, AzFramework::AssetSystem::FileExistsRequest, AzFramework::AssetSystem::FileExistsResponse, AzFramework::AssetSystem::FileFlushRequest, AzFramework::AssetSystem::FileFlushResponse, AzFramework::AssetSystem::PathCreateRequest, AzFramework::AssetSystem::PathCreateResponse, AzFramework::AssetSystem::PathDestroyRequest, AzFramework::AssetSystem::PathDestroyResponse, AzFramework::AssetSystem::FileRemoveRequest, AzFramework::AssetSystem::FileRemoveResponse, AzFramework::AssetSystem::FileCopyRequest, AzFramework::AssetSystem::FileCopyResponse, AzFramework::AssetSystem::FileRenameRequest, AzFramework::AssetSystem::FileRenameResponse, AzFramework::AssetSystem::FindFilesRequest, AzFramework::AssetSystem::FindFilesResponse, AzFramework::AssetSystem::FileTreeRequest, AzFramework::AssetSystem::FileTreeResponse, AzFramework::AssetSystem::AssetChangeReportRequest, and AzFramework::AssetSystem::AssetChangeReportResponse.

RequireFencing()

bool AzFramework::AssetSystem::BaseAssetProcessorMessage::RequireFencing

(

)

const

Some asset messages might require that the requests be evaluated by the asset processor only after the OS has send it a file notification regarding that asset, Otherwise there could be a race condition and the asset request could be processed before the asset processor gets the file notification.To prevent this we create a fence file and only evaluate the request after the asset processor picks up that fence file.We call this fencing.

---

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

• Code/Framework/AzFramework/AzFramework/Asset/AssetProcessorMessages.h