Reads marshaled data of RSC services. More...

#include <RscReader.hpp>

Public Member Functions
	RscReader (Stream &remoteStream)
	Constructs a RscReader instance. More...

	RscReader (const RscReader &arg)
	The default copy constructor. More...

	RscReader (RscReader &&arg) noexcept
	The default move constructor. More...

RscReader &	operator= (const RscReader &arg)
	The default copy-assignment operator. More...

RscReader &	operator= (RscReader &&arg) noexcept
	The default move-assignment operator. More...

	~RscReader (void)
	The default destructor.

RscStream	GetStream (void)
	Gets a stream initialized by this instance. More...

RscStreamReader	GetStreamReader (void)
	Gets a stream reader initialized by this instance. More...

void	Read (RscPtr &result, bool omitTag=false)
	Reads a value from RSC. More...

void	Read (RscConstPtr &result, bool omitTag=false)

void	Read (String &result, bool omitTag=false)
	Reads a value from RSC. More...

void	Read (DateTime &result, bool omitTag=false)
	Reads a value from RSC. More...

void	Read (RscStream &stream, bool omitTag=false)
	Reads a stream from RSC. More...

void	Read (SecurityToken &result, bool omitTag=false)
	Reads a value from RSC. More...

void	Read (RscVariantBase &result, bool omitTag=false)
	Reads a value from RSC. More...

template<RscEnumType T>
void	Read (T &result, bool omitTag=false)
	Reads a value from RSC. More...

template<RscPrimitiveType T>
void	Read (T &result, bool omitTag=false)

template<RscClassType T>
void	Read (T &result, bool omitTag=false)

template<RscSerializableType T>
void	Read (T &result, bool omitTag=false)

template<int N>
void	Read (RscVariant< N > &result, bool omitTag=false)
	Reads a value from RSC. More...

template<class T >
void	Read (std::vector< T > &result, bool omitTag=false)
	Reads an array from RSC. More...

template<class T >
void	Read (std::vector< std::vector< T > > &result, bool omitTag=false)
	Reads an array of arrays from RSC. More...

template<class T , size_t N>
void	Read (std::array< T, N > &result, bool omitTag=false)
	Reads an array from RSC. More...

RscType	ReadTag (void)
	Reads a data tag from RSC. More...

void	ReadTag (RscType expectedTag)
	Reads a data tag from RSC. More...

size_t	ReadFieldCount (void)
	Reads the field count of a struct from RSC. More...

size_t	ReadArrayLength (void)
	Reads the array length of an array from RSC. More...

void	ReadBeginStruct (size_t fieldCount)
	Reads the field count of a struct from RSC. More...

void	ReadEnumeratorTag (RscType expectedTag, bool &isEndTag)
	Reads an enumerator tag from RSC. More...

Impl &	GetImpl (void)
	For internal use only. More...

const Impl &	GetImpl (void) const

Detailed Description

Reads marshaled data of RSC services.

This class is not intended for direct use, but required by RscGenerator to implement services.

Constructor & Destructor Documentation

◆ RscReader() [1/3]

Arp::Base::Rsc::Commons::Services::RscReader::RscReader ( Stream & remoteStream )

explicit

Constructs a RscReader instance.

Parameters

remoteStream The remoteStream stream to read from.

◆ RscReader() [2/3]

Arp::Base::Rsc::Commons::Services::RscReader::RscReader ( const RscReader & arg )

default

The default copy constructor.

Parameters

arg	The argument to copy.

◆ RscReader() [3/3]

Arp::Base::Rsc::Commons::Services::RscReader::RscReader ( RscReader && arg )

defaultnoexcept

The default move constructor.

Parameters

arg	The argument to move.

Member Function Documentation

◆ GetImpl()

const RscReader::Impl & Arp::Base::Rsc::Commons::Services::RscReader::GetImpl ( void )

For internal use only.

Returns: The impl instance.

◆ GetStream()

RscStream Arp::Base::Rsc::Commons::Services::RscReader::GetStream ( void )

Gets a stream initialized by this instance.

Returns: A stream from this instance.

◆ GetStreamReader()

RscStreamReader Arp::Base::Rsc::Commons::Services::RscReader::GetStreamReader ( void )

Gets a stream reader initialized by this instance.

Returns: A stream reader from this instance.

◆ operator=() [1/2]

RscReader & Arp::Base::Rsc::Commons::Services::RscReader::operator= ( const RscReader & arg )

default

The default copy-assignment operator.

Parameters

arg	The argument to copy.

Returns: This instance.

◆ operator=() [2/2]

RscReader & Arp::Base::Rsc::Commons::Services::RscReader::operator= ( RscReader && arg )

defaultnoexcept

The default move-assignment operator.

Parameters

arg	The argument to move.

Returns: This instance.

◆ Read() [1/11]

void Arp::Base::Rsc::Commons::Services::RscReader::Read	(	DateTime &	result,
		bool	omitTag = `false`
	)

Reads a value from RSC.

Parameters

result	The resulting value.
omitTag	`true` if the data tag should be omitted during read, otherwise `false`.

◆ Read() [2/11]

void Arp::Base::Rsc::Commons::Services::RscReader::Read	(	RscPtr &	result,
		bool	omitTag = `false`
	)

Reads a value from RSC.

Parameters

result	The resulting value.
omitTag	`true` if the data tag should be omitted during read, otherwise `false`.

◆ Read() [3/11]

void Arp::Base::Rsc::Commons::Services::RscReader::Read	(	RscStream &	stream,
		bool	omitTag = `false`
	)

Reads a stream from RSC.

Parameters

stream	The stream to read.
omitTag	`true` if the data tag should be omitted during read, otherwise `false`.

◆ Read() [4/11]

template<int N>

void Arp::Base::Rsc::Commons::Services::RscReader::Read	(	RscVariant< N > &	result,
		bool	omitTag = `false`
	)

inline

Reads a value from RSC.

Parameters

result	The resulting value.
omitTag	`true` if the data tag should be omitted during read, otherwise `false`.

◆ Read() [5/11]

void Arp::Base::Rsc::Commons::Services::RscReader::Read	(	RscVariantBase &	result,
		bool	omitTag = `false`
	)

Reads a value from RSC.

Parameters

result	The resulting value.
omitTag	`true` if the data tag should be omitted during read, otherwise `false`.

◆ Read() [6/11]

void Arp::Base::Rsc::Commons::Services::RscReader::Read	(	SecurityToken &	result,
		bool	omitTag = `false`
	)

Reads a value from RSC.

Parameters

result	The resulting value.
omitTag	`true` if the data tag should be omitted during read, otherwise `false`.

◆ Read() [7/11]

template<class T , size_t N>

void Arp::Base::Rsc::Commons::Services::RscReader::Read	(	std::array< T, N > &	result,
		bool	omitTag = `false`
	)

inline

Reads an array from RSC.

Parameters

result	The resulting array.
omitTag	`true` if the data tag should be omitted during read, otherwise `false`.

◆ Read() [8/11]

template<class T >

void Arp::Base::Rsc::Commons::Services::RscReader::Read	(	std::vector< std::vector< T > > &	result,
		bool	omitTag = `false`
	)

inline

Reads an array of arrays from RSC.

Parameters

result	The resulting array.
omitTag	`true` if the data tag should be omitted during read, otherwise `false`.

◆ Read() [9/11]

template<class T >

void Arp::Base::Rsc::Commons::Services::RscReader::Read	(	std::vector< T > &	result,
		bool	omitTag = `false`
	)

inline

Reads an array from RSC.

Parameters

result	The resulting array.
omitTag	`true` if the data tag should be omitted during read, otherwise `false`.

◆ Read() [10/11]

void Arp::Base::Rsc::Commons::Services::RscReader::Read	(	String &	result,
		bool	omitTag = `false`
	)

Reads a value from RSC.

Parameters

result	The resulting value.
omitTag	`true` if the data tag should be omitted during read, otherwise `false`.

◆ Read() [11/11]

template<RscSerializableType T>

void Arp::Base::Rsc::Commons::Services::RscReader::Read	(	T &	result,
		bool	omitTag = `false`
	)

inline

Reads a value from RSC.

Parameters

result	The resulting value.
omitTag	`true` if the data tag should be omitted during read, otherwise `false`.

◆ ReadArrayLength()

size_t Arp::Base::Rsc::Commons::Services::RscReader::ReadArrayLength ( void )

Reads the array length of an array from RSC.

Returns: The read array length.

◆ ReadBeginStruct()

void Arp::Base::Rsc::Commons::Services::RscReader::ReadBeginStruct ( size_t fieldCount )

Reads the field count of a struct from RSC.

Parameters

fieldCount The expected field count.

Exceptions

RscException If the read field count does not match the fieldCount .

◆ ReadEnumeratorTag()

void Arp::Base::Rsc::Commons::Services::RscReader::ReadEnumeratorTag	(	RscType	expectedTag,
		bool &	isEndTag
	)

Reads an enumerator tag from RSC.

Parameters

expectedTag	The expected tag.
isEndTag	Determines if the read tag is an end tag.

Exceptions

RscException If the read tag does not match the expectedTag .

◆ ReadFieldCount()

size_t Arp::Base::Rsc::Commons::Services::RscReader::ReadFieldCount ( void )

Reads the field count of a struct from RSC.

Returns: The read field count.

◆ ReadTag() [1/2]

void Arp::Base::Rsc::Commons::Services::RscReader::ReadTag ( RscType expectedTag )

Reads a data tag from RSC.

Parameters

expectedTag The expected data tag.

Exceptions

RscException If the read tag does not match the expectedTag .

◆ ReadTag() [2/2]

RscType Arp::Base::Rsc::Commons::Services::RscReader::ReadTag ( void )

Reads a data tag from RSC.

Returns: The read data tag.

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

Arp/Base/Rsc/Commons/Services/RscReader.hpp
Arp/Base/Rsc/Commons/Services/RscReader.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ RscReader() [1/3]

◆ RscReader() [2/3]

◆ RscReader() [3/3]

Member Function Documentation

◆ GetImpl()

◆ GetStream()

◆ GetStreamReader()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ Read() [1/11]

◆ Read() [2/11]

◆ Read() [3/11]

◆ Read() [4/11]

◆ Read() [5/11]

◆ Read() [6/11]

◆ Read() [7/11]

◆ Read() [8/11]

◆ Read() [9/11]

◆ Read() [10/11]

◆ Read() [11/11]

◆ ReadArrayLength()

◆ ReadBeginStruct()

◆ ReadEnumeratorTag()

◆ ReadFieldCount()

◆ ReadTag() [1/2]

◆ ReadTag() [2/2]