HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
NET_IODevice Class Referenceabstract

#include <NET_IODevice.h>

+ Inheritance diagram for NET_IODevice:

Public Types

using OpenMode = NET_IODeviceOpenMode
 

Public Member Functions

virtual ~NET_IODevice ()=default
 
 UT_NON_COPYABLE (NET_IODevice)
 
virtual bool atEnd () const
 
virtual exint bytesAvailable () const =0
 
virtual exint read (char *data, exint max_size)
 
virtual UT_Array< char > read (exint max_size)
 
virtual UT_Array< char > readAll ()
 
virtual bool seek (exint pos)
 
virtual exint size () const
 
virtual exint write (const char *data, exint max_size)
 
virtual exint write (const char *data)
 
virtual exint write (const UT_Array< char > &data)
 
virtual exint pos () const =0
 
virtual void close ()
 
virtual bool open (OpenMode mode)
 
virtual bool isSequential () const
 
const UT_ErrorCodeerror () const
 
const UT_StringHoldermime () const
 
void setMime (const UT_StringHolder &mime)
 
OpenMode mode () const
 
bool isReadable () const
 
bool isWriteable () const
 

Protected Member Functions

 NET_IODevice ()=default
 

Protected Attributes

UT_ErrorCode myError
 
UT_StringHolder myMime
 
OpenMode myMode = OpenMode::NotOpen
 

Detailed Description

Definition at line 50 of file NET_IODevice.h.

Member Typedef Documentation

Definition at line 53 of file NET_IODevice.h.

Constructor & Destructor Documentation

virtual NET_IODevice::~NET_IODevice ( )
virtualdefault
NET_IODevice::NET_IODevice ( )
protecteddefault

Member Function Documentation

virtual bool NET_IODevice::atEnd ( ) const
inlinevirtual

Definition at line 58 of file NET_IODevice.h.

virtual exint NET_IODevice::bytesAvailable ( ) const
pure virtual

Implemented in NET_MemBuffer.

virtual void NET_IODevice::close ( )
inlinevirtual

Definition at line 69 of file NET_IODevice.h.

const UT_ErrorCode& NET_IODevice::error ( ) const
inline

Definition at line 80 of file NET_IODevice.h.

bool NET_IODevice::isReadable ( ) const
inline

Definition at line 86 of file NET_IODevice.h.

virtual bool NET_IODevice::isSequential ( ) const
inlinevirtual

Definition at line 79 of file NET_IODevice.h.

bool NET_IODevice::isWriteable ( ) const
inline

Definition at line 91 of file NET_IODevice.h.

const UT_StringHolder& NET_IODevice::mime ( ) const
inline

Definition at line 82 of file NET_IODevice.h.

OpenMode NET_IODevice::mode ( ) const
inline

Definition at line 85 of file NET_IODevice.h.

virtual bool NET_IODevice::open ( OpenMode  mode)
inlinevirtual

Definition at line 74 of file NET_IODevice.h.

virtual exint NET_IODevice::pos ( ) const
pure virtual

Implemented in NET_MemBuffer.

virtual exint NET_IODevice::read ( char *  data,
exint  max_size 
)
inlinevirtual

Reimplemented in NET_MemBuffer.

Definition at line 60 of file NET_IODevice.h.

virtual UT_Array<char> NET_IODevice::read ( exint  max_size)
virtual

Reimplemented in NET_MemBuffer.

virtual UT_Array<char> NET_IODevice::readAll ( )
virtual

Reimplemented in NET_MemBuffer.

virtual bool NET_IODevice::seek ( exint  pos)
inlinevirtual

Reimplemented in NET_MemBuffer.

Definition at line 63 of file NET_IODevice.h.

void NET_IODevice::setMime ( const UT_StringHolder mime)
inline

Definition at line 83 of file NET_IODevice.h.

virtual exint NET_IODevice::size ( void  ) const
inlinevirtual

Reimplemented in NET_MemBuffer.

Definition at line 64 of file NET_IODevice.h.

NET_IODevice::UT_NON_COPYABLE ( NET_IODevice  )
virtual exint NET_IODevice::write ( const char *  data,
exint  max_size 
)
inlinevirtual

Reimplemented in NET_MemBuffer.

Definition at line 65 of file NET_IODevice.h.

virtual exint NET_IODevice::write ( const char *  data)
inlinevirtual

Reimplemented in NET_MemBuffer.

Definition at line 66 of file NET_IODevice.h.

virtual exint NET_IODevice::write ( const UT_Array< char > &  data)
inlinevirtual

Reimplemented in NET_MemBuffer.

Definition at line 67 of file NET_IODevice.h.

Member Data Documentation

UT_ErrorCode NET_IODevice::myError
protected

Definition at line 99 of file NET_IODevice.h.

UT_StringHolder NET_IODevice::myMime
protected

Definition at line 100 of file NET_IODevice.h.

OpenMode NET_IODevice::myMode = OpenMode::NotOpen
protected

Definition at line 101 of file NET_IODevice.h.


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