Gray C++ Libraries  0.0.2
A set of C++ libraries for MSVC, GNU on Windows, WinCE, Linux
Public Member Functions | Friends | List of all members
Gray::cStream Class Reference

#include <cStream.h>

Inheritance diagram for Gray::cStream:
Gray::cStreamInput Gray::cStreamOutput Gray::cStreamBase Gray::cStreamBase Gray::cFile Gray::cStreamNull Gray::cStreamQueue Gray::cStreamStatic GrayLib::cNetSocket GrayLib::cNetStream GrayLib::cNetTOP GrayLib::cSerialPort GraySSL::cSSLCommon

Public Member Functions

virtual STREAM_SEEKRET_t Seek (STREAM_OFFSET_t iOffset, SEEK_ORIGIN_TYPE eSeekOrigin=SEEK_Set) override
 Disambiguate Seek for cStreamBase to cStreamInput for stupid compiler. More...
 
virtual STREAM_POS_t GetPosition () const override
 
virtual STREAM_POS_t GetLength () const override
 
void SeekToBegin ()
 
STREAM_POS_t SeekToEnd ()
 
- Public Member Functions inherited from Gray::cStreamInput
 cStreamInput () noexcept
 
virtual ~cStreamInput ()
 
virtual size_t SetSeekSizeMin (size_t nSizeMin=k_FILE_BLOCK_SIZE)
 
virtual HRESULT ReadX (OUT void *pData, size_t nDataSize)
 
HRESULT ReadAll (OUT cHeapBlock &block, size_t nSizeExtra=0)
 
virtual HRESULT ReadStringLine (OUT char *pszBuffer, StrLen_t iSizeMax)
 
virtual HRESULT ReadStringLine (OUT wchar_t *pszBuffer, StrLen_t iSizeMax)
 
HRESULT ReadT (OUT void *pVal, size_t nSize)
 
template<typename TYPE >
HRESULT ReadT (OUT TYPE &val)
 
template<typename TYPE >
HRESULT ReadTN (OUT TYPE &val)
 
HRESULT ReadSize (OUT size_t &nSize)
 
template<typename TYPE >
HRESULT ReadSizeT (OUT TYPE &n)
 
HRESULT ReadHashCode (OUT UINT32 &nHashCode)
 
HRESULT ReadHashCode (OUT UINT64 &nHashCode)
 
HRESULT ReadN (OUT BYTE *pBuffer, size_t nSizeMax)
 
template<typename _CH >
HRESULT ReadStringN (OUT _CH *pszStr, StrLen_t iSizeMax)
 
virtual HRESULT ReadPeek (void *pData, size_t nDataSize)
 
- Public Member Functions inherited from Gray::cStreamBase
virtual ~cStreamBase ()
 
void SeekToBegin ()
 
STREAM_POS_t SeekToEnd ()
 
- Public Member Functions inherited from Gray::cStreamOutput
 cStreamOutput () noexcept
 
virtual ~cStreamOutput ()
 
virtual HRESULT WriteX (const void *pData, size_t nDataSize)
 
HRESULT WriteT (const void *pVal, size_t nDataSize)
 
template<typename TYPE >
HRESULT WriteT (TYPE val)
 
HRESULT WriteSize (size_t nSize)
 
HRESULT WriteHashCode (HASHCODE_t nHashCode)
 
HRESULT WriteN (const void *pBuffer, size_t nSize)
 
template<typename _CH >
HRESULT WriteStringN (const _CH *pszStr)
 
template<typename _CH >
HRESULT WriteCharRepeat (_CH nChar, int nCount=1)
 
virtual HRESULT WriteString (const char *pszStr)
 
virtual HRESULT WriteString (const wchar_t *pszStr)
 
StrLen_t VPrintf (const char *pszFormat, va_list args)
 
StrLen_t VPrintf (const wchar_t *pszFormat, va_list args)
 
StrLen_t _cdecl Printf (const char *pszFormat,...)
 
StrLen_t _cdecl Printf (const wchar_t *pszFormat,...)
 
HRESULT WriteStream (cStreamInput &sInp, STREAM_POS_t nSizeMax=k_FILE_BLOCK_SIZE, IStreamProgressCallback *pProgress=nullptr, TIMESYSD_t nTimeout=0)
 Copy cStreamInput to this stream. More...
 
virtual HRESULT FlushX ()
 

Friends

class cStreamTests
 

Additional Inherited Members

- Static Public Attributes inherited from Gray::cStreamBase
static const BYTE k_SIZE_MASK = 0x80
 Used for WriteSize() More...
 
static const size_t k_FILE_BLOCK_SIZE = (32 * 1024)
 default arbitrary transfer block size. more than this is NOT more efficient. More...
 

Detailed Description

This is a bi-directional stream. RX and TX Sequential = seek May not be avail from this interface. or only partial support. Similar to MFC cArchive, COM ISequentialStream, std::basic_streambuf ? ASSUME this overrides ReadX() and WriteX() GetLength() optionally avail for this stream. I can move to any place in the stream.

Member Function Documentation

◆ GetLength()

virtual STREAM_POS_t Gray::cStream::GetLength ( ) const
inlineoverridevirtual

Reimplemented from Gray::cStreamBase.

Reimplemented in GraySSL::cSSLCommon, GrayLib::cFileMem, Gray::cStreamStatic, Gray::cStreamQueue, and Gray::cFile.

◆ GetPosition()

virtual STREAM_POS_t Gray::cStream::GetPosition ( ) const
inlineoverridevirtual

Reimplemented from Gray::cStreamBase.

Reimplemented in GrayLib::cFileMem, Gray::cFileText, and Gray::cFile.

◆ Seek()

virtual STREAM_SEEKRET_t Gray::cStream::Seek ( STREAM_OFFSET_t  iOffset,
SEEK_ORIGIN_TYPE  eSeekOrigin = SEEK_Set 
)
inlineoverridevirtual

Disambiguate Seek for cStreamBase to cStreamInput for stupid compiler.

Reimplemented from Gray::cStreamBase.

Reimplemented in Gray::cFileText, Gray::cStreamStatic, Gray::cStreamQueue, GrayLib::cFileMem, Gray::cFile, GraySSL::cSSLCommon, Gray::cStreamTextReader, and GrayLib::cNetStream.

◆ SeekToBegin()

void Gray::cStream::SeekToBegin ( )
inline

◆ SeekToEnd()

STREAM_POS_t Gray::cStream::SeekToEnd ( )
inline

Friends And Related Function Documentation

◆ cStreamTests

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