Generate a 32bit integer hash for a serializable object. NOTE: This hash is not designed to be cryptographically secure. More...

#include <HashSerializer.h>

Inherits AzNetworking::ISerializer.

Public Member Functions
AZ::HashValue32	GetHash () const

SerializerMode	GetSerializerMode () const override

bool	Serialize (bool &value, const char *name) override

bool	Serialize (int8_t &value, const char *name, int8_t minValue, int8_t maxValue) override

bool	Serialize (int16_t &value, const char *name, int16_t minValue, int16_t maxValue) override

bool	Serialize (int32_t &value, const char *name, int32_t minValue, int32_t maxValue) override

bool	Serialize (long &value, const char *name, long minValue, long maxValue) override

bool	Serialize (AZ::s64 &value, const char *name, AZ::s64 minValue, AZ::s64 maxValue) override

bool	Serialize (uint8_t &value, const char *name, uint8_t minValue, uint8_t maxValue) override

bool	Serialize (uint16_t &value, const char *name, uint16_t minValue, uint16_t maxValue) override

bool	Serialize (uint32_t &value, const char *name, uint32_t minValue, uint32_t maxValue) override

bool	Serialize (unsigned long &value, const char *name, unsigned long minValue, unsigned long maxValue) override

bool	Serialize (AZ::u64 &value, const char *name, AZ::u64 minValue, AZ::u64 maxValue) override

bool	Serialize (float &value, const char *name, float minValue, float maxValue) override

bool	Serialize (double &value, const char *name, double minValue, double maxValue) override

bool	SerializeBytes (uint8_t buffer, uint32_t bufferCapacity, bool isString, uint32_t &outSize, const char name) override

bool	BeginObject (const char *name) override

bool	EndObject (const char *name) override

const uint8_t *	GetBuffer () const override

uint32_t	GetCapacity () const override

uint32_t	GetSize () const override

void	ClearTrackedChangesFlag () override

bool	GetTrackedChangesFlag () const override

Public Member Functions inherited from AzNetworking::ISerializer
virtual bool	IsValid () const

void	Invalidate ()
	Mark the serializer as invalid.

virtual SerializerMode	GetSerializerMode () const =0

virtual bool	Serialize (bool &value, const char *name)=0

bool	Serialize (char &value, const char *name, uint8_t minValue=AZStd::numeric_limits< uint8_t >::min(), uint8_t maxValue=AZStd::numeric_limits< uint8_t >::max())

virtual bool	Serialize (int8_t &value, const char *name, int8_t minValue=AZStd::numeric_limits< int8_t >::min(), int8_t maxValue=AZStd::numeric_limits< int8_t >::max())=0

virtual bool	Serialize (int16_t &value, const char *name, int16_t minValue=AZStd::numeric_limits< int16_t >::min(), int16_t maxValue=AZStd::numeric_limits< int16_t >::max())=0

virtual bool	Serialize (int32_t &value, const char *name, int32_t minValue=AZStd::numeric_limits< int32_t >::min(), int32_t maxValue=AZStd::numeric_limits< int32_t >::max())=0

virtual bool	Serialize (long &value, const char *name, long minValue=AZStd::numeric_limits< long >::min(), long maxValue=AZStd::numeric_limits< long >::max())=0

virtual bool	Serialize (AZ::s64 &value, const char *name, AZ::s64 minValue=AZStd::numeric_limits< AZ::s64 >::min(), AZ::s64 maxValue=AZStd::numeric_limits< AZ::s64 >::max())=0

virtual bool	Serialize (uint8_t &value, const char *name, uint8_t minValue=AZStd::numeric_limits< uint8_t >::min(), uint8_t maxValue=AZStd::numeric_limits< uint8_t >::max())=0

virtual bool	Serialize (uint16_t &value, const char *name, uint16_t minValue=AZStd::numeric_limits< uint16_t >::min(), uint16_t maxValue=AZStd::numeric_limits< uint16_t >::max())=0

virtual bool	Serialize (uint32_t &value, const char *name, uint32_t minValue=AZStd::numeric_limits< uint32_t >::min(), uint32_t maxValue=AZStd::numeric_limits< uint32_t >::max())=0

virtual bool	Serialize (unsigned long &value, const char *name, unsigned long minValue=AZStd::numeric_limits< unsigned long >::min(), unsigned long maxValue=AZStd::numeric_limits< uint64_t >::max())=0

virtual bool	Serialize (AZ::u64 &value, const char *name, AZ::u64 minValue=AZStd::numeric_limits< AZ::u64 >::min(), AZ::u64 maxValue=AZStd::numeric_limits< AZ::u64 >::max())=0

virtual bool	Serialize (float &value, const char *name, float minValue=AZStd::numeric_limits< float >::min(), float maxValue=AZStd::numeric_limits< float >::max())=0

virtual bool	Serialize (double &value, const char *name, double minValue=AZStd::numeric_limits< double >::min(), double maxValue=AZStd::numeric_limits< double >::max())=0

virtual bool	SerializeBytes (uint8_t buffer, uint32_t bufferCapacity, bool isString, uint32_t &outSize, const char name)=0

template<typename TYPE >
bool	Serialize (TYPE &value, const char *name)

virtual bool	BeginObject (const char *name)=0

virtual bool	EndObject (const char *name)=0

virtual const uint8_t *	GetBuffer () const =0

virtual uint32_t	GetCapacity () const =0

virtual uint32_t	GetSize () const =0

virtual void	ClearTrackedChangesFlag ()=0

virtual bool	GetTrackedChangesFlag () const =0

Additional Inherited Members
Protected Attributes inherited from AzNetworking::ISerializer
bool	m_serializerValid = true

Detailed Description

Generate a 32bit integer hash for a serializable object. NOTE: This hash is not designed to be cryptographically secure.

Member Function Documentation

◆ BeginObject()

bool AzNetworking::HashSerializer::BeginObject ( const char * name )

overridevirtual

Begins serializing an object.

Parameters

name	string name of the object

Returns: boolean true on success, false for failure

Implements AzNetworking::ISerializer.

◆ ClearTrackedChangesFlag()

void AzNetworking::HashSerializer::ClearTrackedChangesFlag ( )

inlineoverridevirtual

This is a helper for network serialization. It clears the track changes flag internal to some serializers

Implements AzNetworking::ISerializer.

◆ EndObject()

bool AzNetworking::HashSerializer::EndObject ( const char * name )

overridevirtual

Ends serializing an object.

Parameters

name	string name of the object

Returns: boolean true on success, false for failure

Implements AzNetworking::ISerializer.

◆ GetBuffer()

const uint8_t * AzNetworking::HashSerializer::GetBuffer ( ) const

overridevirtual

Returns a pointer to the internal serialization buffer.

Returns: pointer to the internal serialization buffer

Implements AzNetworking::ISerializer.

◆ GetCapacity()

uint32_t AzNetworking::HashSerializer::GetCapacity ( ) const

overridevirtual

Returns the total capacity serialization buffer in bytes.

Returns: total capacity serialization buffer in bytes

Implements AzNetworking::ISerializer.

◆ GetSerializerMode()

SerializerMode AzNetworking::HashSerializer::GetSerializerMode ( ) const

overridevirtual

Returns an enum the represents the serializer mode. returns WriteToObject if the serializer is writing values to the objects it visits, otherwise returns ReadFromObject

Returns: boolean true if the serializer is writing to objects that it visits

Implements AzNetworking::ISerializer.

◆ GetSize()

uint32_t AzNetworking::HashSerializer::GetSize ( ) const

overridevirtual

Returns the size of the data contained in the serialization buffer in bytes.

Returns: size of the data contained in the serialization buffer in bytes

Implements AzNetworking::ISerializer.

◆ GetTrackedChangesFlag()

bool AzNetworking::HashSerializer::GetTrackedChangesFlag ( ) const

inlineoverridevirtual

This is a helper for network serialization. It allows the owner of the serializer to query whether or not the serializer modified the state of an object during serialization

Returns: boolean true if the track changes flag is raised

Implements AzNetworking::ISerializer.

◆ Serialize() [1/13]

bool AzNetworking::HashSerializer::Serialize	(	AZ::s64 &	value,
		const char *	name,
		AZ::s64	minValue,
		AZ::s64	maxValue
	)

overridevirtual

Serialize a signed 64-bit integer (long long).

Parameters

value	signed 64-bit integer input value to serialize
name	string name of the value being serialized
minValue	the minimum value expected during serialization
maxValue	the maximum value expected during serialization

Returns: boolean true for success, false for failure

Implements AzNetworking::ISerializer.

◆ Serialize() [2/13]

bool AzNetworking::HashSerializer::Serialize	(	AZ::u64 &	value,
		const char *	name,
		AZ::u64	minValue,
		AZ::u64	maxValue
	)

overridevirtual

Serialize an unsigned 64-bit integer (unsigned long long).

Parameters

value	unsigned 64-bit integer input value to serialize
name	string name of the value being serialized
minValue	the minimum value expected during serialization
maxValue	the maximum value expected during serialization

Returns: boolean true for success, false for failure

Implements AzNetworking::ISerializer.

◆ Serialize() [3/13]

bool AzNetworking::HashSerializer::Serialize	(	bool &	value,
		const char *	name
	)

overridevirtual

Serialize a boolean.

Parameters

value	boolean input value to serialize
name	string name of the value being serialized

Returns: boolean true for success, false for serialization failure

Implements AzNetworking::ISerializer.

◆ Serialize() [4/13]

bool AzNetworking::HashSerializer::Serialize	(	double &	value,
		const char *	name,
		double	minValue,
		double	maxValue
	)

overridevirtual

Serialize a 64-bit floating point number.

Parameters

value	64-bit floating point input value to serialize
name	string name of the value being serialized
minValue	the minimum value expected during serialization
maxValue	the maximum value expected during serialization

Returns: boolean true for success, false for failure

Implements AzNetworking::ISerializer.

◆ Serialize() [5/13]

bool AzNetworking::HashSerializer::Serialize	(	float &	value,
		const char *	name,
		float	minValue,
		float	maxValue
	)

overridevirtual

Serialize a 32-bit floating point number.

Parameters

value	32-bit floating point input value to serialize
name	string name of the value being serialized
minValue	the minimum value expected during serialization
maxValue	the maximum value expected during serialization

Returns: boolean true for success, false for failure

Implements AzNetworking::ISerializer.

◆ Serialize() [6/13]

bool AzNetworking::HashSerializer::Serialize	(	int16_t &	value,
		const char *	name,
		int16_t	minValue,
		int16_t	maxValue
	)

overridevirtual

Serialize a signed short.

Parameters

value	signed short input value to serialize
name	string name of the value being serialized
minValue	the minimum value expected during serialization
maxValue	the maximum value expected during serialization

Returns: boolean true for success, false for failure

Implements AzNetworking::ISerializer.

◆ Serialize() [7/13]

bool AzNetworking::HashSerializer::Serialize	(	int32_t &	value,
		const char *	name,
		int32_t	minValue,
		int32_t	maxValue
	)

overridevirtual

Serialize a signed integer.

Parameters

value	signed integer input value to serialize
name	string name of the value being serialized
minValue	the minimum value expected during serialization
maxValue	the maximum value expected during serialization

Returns: boolean true for success, false for failure

Implements AzNetworking::ISerializer.

◆ Serialize() [8/13]

bool AzNetworking::HashSerializer::Serialize	(	int8_t &	value,
		const char *	name,
		int8_t	minValue,
		int8_t	maxValue
	)

overridevirtual

Serialize a signed byte.

Parameters

value	signed byte input value to serialize
name	string name of the value being serialized
minValue	the minimum value expected during serialization
maxValue	the maximum value expected during serialization

Returns: boolean true for success, false for failure

Implements AzNetworking::ISerializer.

◆ Serialize() [9/13]

bool AzNetworking::HashSerializer::Serialize	(	long &	value,
		const char *	name,
		long	minValue,
		long	maxValue
	)

overridevirtual

Serialize a signed long integer.

Parameters

value	signed long integer input value to serialize
name	string name of the value being serialized
minValue	the minimum value expected during serialization
maxValue	the maximum value expected during serialization

Returns: boolean true for success, false for failure

Implements AzNetworking::ISerializer.

◆ Serialize() [10/13]

bool AzNetworking::HashSerializer::Serialize	(	uint16_t &	value,
		const char *	name,
		uint16_t	minValue,
		uint16_t	maxValue
	)

overridevirtual

Serialize an unsigned short.

Parameters

value	unsigned integer short value to serialize
name	string name of the value being serialized
minValue	the minimum value expected during serialization
maxValue	the maximum value expected during serialization

Returns: boolean true for success, false for failure

Implements AzNetworking::ISerializer.

◆ Serialize() [11/13]

bool AzNetworking::HashSerializer::Serialize	(	uint32_t &	value,
		const char *	name,
		uint32_t	minValue,
		uint32_t	maxValue
	)

overridevirtual

Serialize an unsigned integer.

Parameters

value	unsigned integer input value to serialize
name	string name of the value being serialized
minValue	the minimum value expected during serialization
maxValue	the maximum value expected during serialization

Returns: boolean true for success, false for failure

Implements AzNetworking::ISerializer.

◆ Serialize() [12/13]

bool AzNetworking::HashSerializer::Serialize	(	uint8_t &	value,
		const char *	name,
		uint8_t	minValue,
		uint8_t	maxValue
	)

overridevirtual

Serialize an unsigned byte.

Parameters

value	unsigned byte input value to serialize
name	string name of the value being serialized
minValue	the minimum value expected during serialization
maxValue	the maximum value expected during serialization

Returns: boolean true for success, false for failure

Implements AzNetworking::ISerializer.

◆ Serialize() [13/13]

bool AzNetworking::HashSerializer::Serialize	(	unsigned long &	value,
		const char *	name,
		unsigned long	minValue,
		unsigned long	maxValue
	)

overridevirtual

Serialize an unsigned long integer.

Parameters

value	unsigned long integer input value to serialize
name	string name of the value being serialized
minValue	the minimum value expected during serialization
maxValue	the maximum value expected during serialization

Returns: boolean true for success, false for failure

Implements AzNetworking::ISerializer.

◆ SerializeBytes()

bool AzNetworking::HashSerializer::SerializeBytes	(	uint8_t *	buffer,
		uint32_t	bufferCapacity,
		bool	isString,
		uint32_t &	outSize,
		const char *	name
	)

overridevirtual

Serialize a raw set of bytes.

Parameters

buffer	buffer to serialize
bufferCapacity	size of the buffer
isString	true if the data being serialized is a string
outSize	bytes serialized
name	string name of the object

Returns: boolean true for success, false for serialization failure

Implements AzNetworking::ISerializer.

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

Code/Framework/AzNetworking/AzNetworking/Serialization/HashSerializer.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ BeginObject()

◆ ClearTrackedChangesFlag()

◆ EndObject()

◆ GetBuffer()

◆ GetCapacity()

◆ GetSerializerMode()

◆ GetSize()

◆ GetTrackedChangesFlag()

◆ Serialize() [1/13]

◆ Serialize() [2/13]

◆ Serialize() [3/13]

◆ Serialize() [4/13]

◆ Serialize() [5/13]

◆ Serialize() [6/13]

◆ Serialize() [7/13]

◆ Serialize() [8/13]

◆ Serialize() [9/13]

◆ Serialize() [10/13]

◆ Serialize() [11/13]

◆ Serialize() [12/13]

◆ Serialize() [13/13]

◆ SerializeBytes()