Open 3D Engine AzFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
AzFramework::RemoteToolsMessage Class Reference

Inherits AZStd::intrusive_refcount< size_t >.

Inherited by AzFramework::ScriptDebugAck, AzFramework::ScriptDebugAckBreakpoint, AzFramework::ScriptDebugAckExecute, AzFramework::ScriptDebugCallStackResult, AzFramework::ScriptDebugEnumContextsResult, AzFramework::ScriptDebugEnumLocalsResult, AzFramework::ScriptDebugGetValueResult, AzFramework::ScriptDebugRegisteredClassesResult, AzFramework::ScriptDebugRegisteredEBusesResult, AzFramework::ScriptDebugRegisteredGlobalsResult, AzFramework::ScriptDebugRequest, AzFramework::ScriptDebugSetValue, and AzFramework::ScriptDebugSetValueResult.

Public Member Functions

 AZ_CLASS_ALLOCATOR (RemoteToolsMessage, AZ::OSAllocator)
 
 AZ_RTTI (RemoteToolsMessage, "{8512328C-949D-4F0C-B48D-77C26C207443}")
 
 RemoteToolsMessage (AZ::u64 msgId)
 
void AddCustomBlob (const void *blob, size_t blobSize, bool ownBlob=false)
 
void AddCustomBlob (AZStd::span< AZStd::byte const > blob, bool ownBlob=false)
 
const AZStd::span< AZStd::byte const > GetCustomBlob () const
 
size_t GetCustomBlobSize () const
 
bool GetIsBlobOwner () const
 
AZ::u64 GetId () const
 
AZ::u32 GetSenderTargetId () const
 
void SetSenderTargetId (AZ::u32 senderTargetId)
 

Static Public Member Functions

static void ReflectRemoteToolsMessage (AZ::ReflectContext *reflection)
 

Protected Attributes

AZ::u64 m_msgId = 0
 
AZ::u32 m_senderTargetId = 0
 
AZStd::span< AZStd::byte const > m_customBlob
 
bool m_isBlobOwner = false
 

Member Function Documentation

◆ AddCustomBlob() [1/2]

void AzFramework::RemoteToolsMessage::AddCustomBlob ( AZStd::span< AZStd::byte const >  blob,
bool  ownBlob = false 
)
inline

Add a custom data blob to a Remote Tools message

Parameters
blobSpan of byte representing the blob
ownBlobWhether this message owns the life cycle of the blob memory

◆ AddCustomBlob() [2/2]

void AzFramework::RemoteToolsMessage::AddCustomBlob ( const void *  blob,
size_t  blobSize,
bool  ownBlob = false 
)
inline

Add a custom data blob to a Remote Tools message

Parameters
blobPointer to the start of the data blob
blobSizeSize of the data blob
ownBlobWhether this message owns the life cycle of the blob memory

◆ GetCustomBlob()

const AZStd::span< AZStd::byte const > AzFramework::RemoteToolsMessage::GetCustomBlob ( ) const
inline

Gets the custom data blob associated with this message

Returns
Memory address of the start of the blob or nullptr if there is none

◆ GetCustomBlobSize()

size_t AzFramework::RemoteToolsMessage::GetCustomBlobSize ( ) const
inline

Gets the size of the custom data blob associated with this message

Returns
Size of the data blob or 0 if there is none

◆ GetId()

AZ::u64 AzFramework::RemoteToolsMessage::GetId ( ) const
inline

Gets the numeric ID of this message

Returns
The ID of this message

◆ GetIsBlobOwner()

bool AzFramework::RemoteToolsMessage::GetIsBlobOwner ( ) const
inline

Gets if this message owns blob memory

Returns
True if the message owns the blob

◆ GetSenderTargetId()

AZ::u32 AzFramework::RemoteToolsMessage::GetSenderTargetId ( ) const
inline

Gets this message's sender's ID

Returns
ID of the message's sender

◆ ReflectRemoteToolsMessage()

void AzFramework::RemoteToolsMessage::ReflectRemoteToolsMessage ( AZ::ReflectContext *  reflection)
inlinestatic

Reflect RemoteToolsMessage

Parameters
reflectionContext to reflect to

◆ SetSenderTargetId()

void AzFramework::RemoteToolsMessage::SetSenderTargetId ( AZ::u32  senderTargetId)
inline

Sets the ID of this message's sender

Parameters
senderTargetIdThe ID to set for this message's sender
The documentation for this class was generated from the following files: