dmlc::io::s3::CURLReadStreamBase Class Reference

reader stream that can be used to read from CURL More...

Inheritance diagram for dmlc::io::s3::CURLReadStreamBase:

Public Member Functions
virtual size_t	Tell (void)
	tell the position of the stream
virtual bool	AtEnd (void) const
virtual void	Write (const void *ptr, size_t size)
	writes data to a stream
virtual void	Seek (size_t pos)
	seek to certain position of the file
virtual size_t	Read (void *ptr, size_t size)
	reads data from a stream
Public Member Functions inherited from dmlc::Stream
virtual	~Stream (void)
	virtual destructor
template<typename T >
void	Write (const T &data)
	writes a data to stream.
template<typename T >
bool	Read (T *out_data)
	loads a data from stream.
template<typename T >
void	WriteArray (const T *data, size_t num_elems)
	Endian aware write array of data.
template<typename T >
bool	ReadArray (T *data, size_t num_elems)
	Endian aware read array of data.

Protected Member Functions
virtual void	InitRequest (size_t begin_bytes, CURL *ecurl, curl_slist **slist)=0
	initialize the ecurl request,

Protected Attributes
size_t	expect_file_size_

Additional Inherited Members
Static Public Member Functions inherited from dmlc::SeekStream
static SeekStream *	CreateForRead (const char *uri, bool allow_null=false)
	generic factory function create an SeekStream for read only, the stream will close the underlying files upon deletion error will be reported and the system will exit when create failed
Static Public Member Functions inherited from dmlc::Stream
static Stream *	Create (const char *uri, const char *const flag, bool allow_null=false)
	generic factory function create an stream, the stream will close the underlying files upon deletion

Detailed Description

reader stream that can be used to read from CURL

Member Function Documentation

InitRequest()

virtual void dmlc::io::s3::CURLReadStreamBase::InitRequest ( size_t  begin_bytes, CURL *  ecurl, curl_slist **  slist  )

protectedpure virtual

initialize the ecurl request,

Parameters

begin_bytes	the beginning bytes of the stream
ecurl	a curl easy handle that can be used to set request
slist	a curl slist handle that can be used to set headers

Implemented in dmlc::io::s3::ReadStream, and dmlc::io::s3::HttpReadStream.

Read()

size_t dmlc::io::s3::CURLReadStreamBase::Read ( void *  ptr, size_t  size  )

virtual

reads data from a stream

Parameters

ptr	pointer to a memory buffer
size	block size

Returns

the size of data read

Implements dmlc::Stream.

Seek()

virtual void dmlc::io::s3::CURLReadStreamBase::Seek ( size_t  pos )

inlinevirtual

seek to certain position of the file

Implements dmlc::SeekStream.

Tell()

virtual size_t dmlc::io::s3::CURLReadStreamBase::Tell ( void  )

inlinevirtual

tell the position of the stream

Implements dmlc::SeekStream.

Write()

virtual void dmlc::io::s3::CURLReadStreamBase::Write ( const void *  ptr, size_t  size  )

inlinevirtual

writes data to a stream

Parameters

ptr	pointer to a memory buffer
size	block size

Implements dmlc::Stream.

---

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

• External/xgboost/dmlc-core/src/io/s3_filesys.cc