Represents a value that can be sent to or received from a SignalR hub. More...

#include <SignalRValue.h>

Inheritance diagram for FSignalRValue:

Public Types
enum class	EValueType { Number , Object , Array , String , Null , Boolean , Binary }
	Enumeration of possible value types that can be stored in a FSignalRValue. More...

Public Member Functions
	FSignalRValue ()
	Create an object representing a EValueType::Null value.

	FSignalRValue (std::nullptr_t)
	Create an object representing a EValueType::Null value.

	FSignalRValue (const int32 InValue)
	Create an object representing a EValueType::Number with the given integer value.

	FSignalRValue (const uint32 InValue)
	Create an object representing a EValueType::Number with the given unsigned integer value.

	FSignalRValue (const int64 InValue)
	Create an object representing a EValueType::Number with the given 64-bit integer value.

	FSignalRValue (const uint64 InValue)
	Create an object representing a EValueType::Number with the given unsigned 64-bit integer value.

	FSignalRValue (const float InValue)
	Create an object representing a EValueType::Number with the given float value.

	FSignalRValue (const double InValue)
	Create an object representing a EValueType::Number with the given double value.

	FSignalRValue (const TMap< FString, FSignalRValue > &InValue)
	Create an object representing a EValueType::Object with the given map of string-values.

	FSignalRValue (TMap< FString, FSignalRValue > &&InValue)
	Create an object representing a EValueType::Object with the given map of string-values.

	FSignalRValue (const TArray< FSignalRValue > &InValue)
	Create an object representing a EValueType::Array with the given array of values.

	FSignalRValue (TArray< FSignalRValue > &&InValue)
	Create an object representing a EValueType::Array with the given array of values.

	FSignalRValue (const FString &InValue)
	Create an object representing a EValueType::String with the given string value.

	FSignalRValue (FString &&InValue)
	Create an object representing a EValueType::String with the given string value.

	FSignalRValue (bool InValue)
	Create an object representing a EValueType::Boolean with the given bool value.

	FSignalRValue (const TArray< uint8 > &InValue)
	Create an object representing a EValueType::Binary with the given array of byte's.

	FSignalRValue (TArray< uint8 > &&InValue)
	Create an object representing a EValueType::Binary with the given array of byte's.

	FSignalRValue (const FSignalRValue &OtherValue)
	Copies an existing value.

	FSignalRValue (FSignalRValue &&OtherValue) noexcept
	Moves an existing value.

	~FSignalRValue ()=default
	Cleans up the resources associated with the value.

FSignalRValue &	operator= (const FSignalRValue &OtherValue)
	Copies an existing value.

FSignalRValue &	operator= (FSignalRValue &&OtherValue) noexcept
	Moves an existing value.

FORCEINLINE bool	IsNumber () const

FORCEINLINE bool	IsObject () const

FORCEINLINE bool	IsString () const

FORCEINLINE bool	IsNull () const

FORCEINLINE bool	IsArray () const

FORCEINLINE bool	IsBoolean () const

FORCEINLINE bool	IsBinary () const

FORCEINLINE EValueType	GetType () const

FORCEINLINE int64	AsInt () const

FORCEINLINE uint64	AsUInt () const

FORCEINLINE float	AsFloat () const

FORCEINLINE double	AsDouble () const

FORCEINLINE double	AsNumber () const

FORCEINLINE const TMap< FString, FSignalRValue > &	AsObject () const

FORCEINLINE const TArray< FSignalRValue > &	AsArray () const

FORCEINLINE const FString &	AsString () const

FORCEINLINE bool	AsBool () const

FORCEINLINE const TArray< uint8 > &	AsBinary () const

Detailed Description

Represents a value that can be sent to or received from a SignalR hub.

Supports various data types including numbers, objects, arrays, strings, booleans, and binary data.

Member Enumeration Documentation

◆ EValueType

enum class FSignalRValue::EValueType

strong

Enumeration of possible value types that can be stored in a FSignalRValue.

Enumerator
Number
Object
Array
String
Null
Boolean
Binary

Constructor & Destructor Documentation

◆ FSignalRValue() [1/19]

FSignalRValue::FSignalRValue ( )

inline

Create an object representing a EValueType::Null value.

◆ FSignalRValue() [2/19]

FSignalRValue::FSignalRValue ( std::nullptr_t )

inline

Create an object representing a EValueType::Null value.

◆ FSignalRValue() [3/19]

FSignalRValue::FSignalRValue ( const int32 InValue )

inline

Create an object representing a EValueType::Number with the given integer value.

Parameters

InValue The integer value to store.

◆ FSignalRValue() [4/19]

FSignalRValue::FSignalRValue ( const uint32 InValue )

inline

Create an object representing a EValueType::Number with the given unsigned integer value.

Parameters

InValue The unsigned integer value to store.

◆ FSignalRValue() [5/19]

FSignalRValue::FSignalRValue ( const int64 InValue )

inline

Create an object representing a EValueType::Number with the given 64-bit integer value.

Parameters

InValue The 64-bit integer value to store.

◆ FSignalRValue() [6/19]

FSignalRValue::FSignalRValue ( const uint64 InValue )

inline

Create an object representing a EValueType::Number with the given unsigned 64-bit integer value.

Parameters

InValue The unsigned 64-bit integer value to store.

◆ FSignalRValue() [7/19]

FSignalRValue::FSignalRValue ( const float InValue )

inline

Create an object representing a EValueType::Number with the given float value.

Parameters

InValue The float value to store.

◆ FSignalRValue() [8/19]

FSignalRValue::FSignalRValue ( const double InValue )

inline

Create an object representing a EValueType::Number with the given double value.

Parameters

InValue The double value to store.

◆ FSignalRValue() [9/19]

FSignalRValue::FSignalRValue ( const TMap< FString, FSignalRValue > & InValue )

inline

Create an object representing a EValueType::Object with the given map of string-values.

Parameters

InValue The map of key-value pairs to store.

◆ FSignalRValue() [10/19]

FSignalRValue::FSignalRValue ( TMap< FString, FSignalRValue > && InValue )

inline

Create an object representing a EValueType::Object with the given map of string-values.

Parameters

InValue The map of key-value pairs to store (moved).

◆ FSignalRValue() [11/19]

FSignalRValue::FSignalRValue ( const TArray< FSignalRValue > & InValue )

inline

Create an object representing a EValueType::Array with the given array of values.

Parameters

InValue The array of values to store.

◆ FSignalRValue() [12/19]

FSignalRValue::FSignalRValue ( TArray< FSignalRValue > && InValue )

inline

Create an object representing a EValueType::Array with the given array of values.

Parameters

InValue The array of values to store (moved).

◆ FSignalRValue() [13/19]

FSignalRValue::FSignalRValue ( const FString & InValue )

inline

Create an object representing a EValueType::String with the given string value.

Parameters

InValue The string value to store.

◆ FSignalRValue() [14/19]

FSignalRValue::FSignalRValue ( FString && InValue )

inline

Create an object representing a EValueType::String with the given string value.

Parameters

InValue The string value to store (moved).

◆ FSignalRValue() [15/19]

FSignalRValue::FSignalRValue ( bool InValue )

inline

Create an object representing a EValueType::Boolean with the given bool value.

Parameters

InValue The boolean value to store.

◆ FSignalRValue() [16/19]

FSignalRValue::FSignalRValue ( const TArray< uint8 > & InValue )

inline

Create an object representing a EValueType::Binary with the given array of byte's.

Parameters

InValue The binary data to store.

◆ FSignalRValue() [17/19]

FSignalRValue::FSignalRValue ( TArray< uint8 > && InValue )

inline

Create an object representing a EValueType::Binary with the given array of byte's.

Parameters

InValue The binary data to store (moved).

◆ FSignalRValue() [18/19]

FSignalRValue::FSignalRValue ( const FSignalRValue & OtherValue )

inline

Copies an existing value.

Parameters

OtherValue The value to copy.

◆ FSignalRValue() [19/19]

FSignalRValue::FSignalRValue ( FSignalRValue && OtherValue )

inlinenoexcept

Moves an existing value.

Parameters

OtherValue The value to move from.

◆ ~FSignalRValue()

FSignalRValue::~FSignalRValue ( )

default

Cleans up the resources associated with the value.

Member Function Documentation

◆ AsArray()

FORCEINLINE const TArray< FSignalRValue > & FSignalRValue::AsArray ( ) const

inline

Returns: The stored value as an array.

◆ AsBinary()

FORCEINLINE const TArray< uint8 > & FSignalRValue::AsBinary ( ) const

inline

Returns: The stored value as binary data.

◆ AsBool()

FORCEINLINE bool FSignalRValue::AsBool ( ) const

inline

Returns: The stored value as a boolean.

◆ AsDouble()

FORCEINLINE double FSignalRValue::AsDouble ( ) const

inline

Returns: The stored value as a double.

◆ AsFloat()

FORCEINLINE float FSignalRValue::AsFloat ( ) const

inline

Returns: The stored value as a float.

◆ AsInt()

FORCEINLINE int64 FSignalRValue::AsInt ( ) const

inline

Returns: The stored value as an int64.

◆ AsNumber()

FORCEINLINE double FSignalRValue::AsNumber ( ) const

inline

Returns: The stored value as a double.

◆ AsObject()

FORCEINLINE const TMap< FString, FSignalRValue > & FSignalRValue::AsObject ( ) const

inline

Returns: The stored value as a map.

◆ AsString()

FORCEINLINE const FString & FSignalRValue::AsString ( ) const

inline

Returns: The stored value as a string.

◆ AsUInt()

FORCEINLINE uint64 FSignalRValue::AsUInt ( ) const

inline

Returns: The stored value as a uint64.

◆ GetType()

FORCEINLINE EValueType FSignalRValue::GetType ( ) const

inline

Returns: The EValueType of the stored value.

◆ IsArray()

FORCEINLINE bool FSignalRValue::IsArray ( ) const

inline

Returns: True if the value is an array, false otherwise.

◆ IsBinary()

FORCEINLINE bool FSignalRValue::IsBinary ( ) const

inline

Returns: True if the value is binary data, false otherwise.

◆ IsBoolean()

FORCEINLINE bool FSignalRValue::IsBoolean ( ) const

inline

Returns: True if the value is a boolean, false otherwise.

◆ IsNull()

FORCEINLINE bool FSignalRValue::IsNull ( ) const

inline

Returns: True if the value is null, false otherwise.

◆ IsNumber()

FORCEINLINE bool FSignalRValue::IsNumber ( ) const

inline

Returns: True if the value is a number, false otherwise.

◆ IsObject()

FORCEINLINE bool FSignalRValue::IsObject ( ) const

inline

Returns: True if the value is an object, false otherwise.

◆ IsString()

FORCEINLINE bool FSignalRValue::IsString ( ) const

inline

Returns: True if the value is a string, false otherwise.

◆ operator=() [1/2]

FSignalRValue & FSignalRValue::operator= ( const FSignalRValue & OtherValue )

inline

Copies an existing value.

Parameters

OtherValue The value to copy.

Returns: Reference to this object.

◆ operator=() [2/2]

FSignalRValue & FSignalRValue::operator= ( FSignalRValue && OtherValue )

inlinenoexcept

Moves an existing value.

Parameters

OtherValue The value to move from.

Returns: Reference to this object.

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

SignalRValue.h

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ EValueType

Constructor & Destructor Documentation

◆ FSignalRValue() [1/19]

◆ FSignalRValue() [2/19]

◆ FSignalRValue() [3/19]

◆ FSignalRValue() [4/19]

◆ FSignalRValue() [5/19]

◆ FSignalRValue() [6/19]

◆ FSignalRValue() [7/19]

◆ FSignalRValue() [8/19]

◆ FSignalRValue() [9/19]

◆ FSignalRValue() [10/19]

◆ FSignalRValue() [11/19]

◆ FSignalRValue() [12/19]

◆ FSignalRValue() [13/19]

◆ FSignalRValue() [14/19]

◆ FSignalRValue() [15/19]

◆ FSignalRValue() [16/19]

◆ FSignalRValue() [17/19]

◆ FSignalRValue() [18/19]

◆ FSignalRValue() [19/19]

◆ ~FSignalRValue()

Member Function Documentation

◆ AsArray()

◆ AsBinary()

◆ AsBool()

◆ AsDouble()

◆ AsFloat()

◆ AsInt()

◆ AsNumber()

◆ AsObject()

◆ AsString()

◆ AsUInt()

◆ GetType()

◆ IsArray()

◆ IsBinary()

◆ IsBoolean()

◆ IsNull()

◆ IsNumber()

◆ IsObject()

◆ IsString()

◆ operator=() [1/2]

◆ operator=() [2/2]