Davix::DavFile Class Reference

Davix File Interface. More...

#include <davfile.hpp>

Inheritance diagram for Davix::DavFile:

Public Member Functions
	DavFile (Context &c, const Uri &url)
	default constructor More...
virtual	~DavFile ()
	destructor
dav_ssize_t	getAllReplicas (const RequestParams *params, ReplicaVec &vec, DavixError **err)
	return all replicas associated to this file More...
dav_ssize_t	readPartialBufferVec (const RequestParams *params, const DavIOVecInput *input_vec, DavIOVecOuput *ioutput_vec, const dav_size_t count_vec, DavixError **err)
	Vector read operation Allow to do several read several data chunk in one single operation Use Http multi-part when supported by the server, simulate a vector read operation in the other case. More...
dav_ssize_t	readPartial (const RequestParams *params, void *buff, dav_size_t count, dav_off_t offset, DavixError **err)
	Partial position independant read. More...
dav_ssize_t	getToFd (const RequestParams *params, int fd, DavixError **err)
	Get the full file content and write it to fd. More...
dav_ssize_t	getToFd (const RequestParams *params, int fd, dav_size_t size_read, DavixError **err)
	Get the first 'size_read' bytes of the file and write it to fd. More...
dav_ssize_t	getFull (const RequestParams *params, std::vector< char > &buffer, DavixError **err)
	Get the full file content in a dynamically allocated buffer. More...
int	putFromFd (const RequestParams *params, int fd, dav_size_t size_write, DavixError **err)
	create and replace the file with the content of the file descriptor fd More...
int	deletion (const RequestParams *params, DavixError **err)
	Suppress the current entity. able to suppress collection too. More...
int	makeCollection (const RequestParams *params, DavixError **err)
	create a collection ( directory or bucket) at the current file url More...
int	stat (const RequestParams *params, struct stat *st, DavixError **err)
	execute a POSIX-like stat() query More...
void	prefetchInfo (off_t offset, dav_size_t size_read, advise_t adv)
	provide informations on the next file operation More...

Detailed Description

Davix File Interface.

Davix File interface

Constructor & Destructor Documentation

Davix::DavFile::DavFile	(	Context &	c,
		const Uri &	url
	)

default constructor

Parameters

c	context
url	Remote File URL

Member Function Documentation

int Davix::DavFile::deletion	(	const RequestParams *	params,
		DavixError **	err
	)

Suppress the current entity. able to suppress collection too.

Parameters

params	Davix request Parameters
err	Davix Error report

Returns

0 if success, or -1 if error occures

dav_ssize_t Davix::DavFile::getAllReplicas	(	const RequestParams *	params,
		ReplicaVec &	vec,
		DavixError **	err
	)

return all replicas associated to this file

Replicas are found using a corresponding meta-link file or Webdav extensions if supported

Parameters

params	Davix Request parameters
vec
err	DavixError error report

Returns

Replica vector, if error is found return 0 and set err properly

dav_ssize_t Davix::DavFile::getFull	(	const RequestParams *	params,
		std::vector< char > &	buffer,
		DavixError **	err
	)

Get the full file content in a dynamically allocated buffer.

Parameters

params	Davix request Parameters
buffer	reference to a vector for the result
err	Davix Error report

Returns

total number of bytes read, or -1 if error occures

dav_ssize_t Davix::DavFile::getToFd	(	const RequestParams *	params,
		int	fd,
		DavixError **	err
	)

Get the full file content and write it to fd.

Parameters

params	Davix request Parameters
fd	file descriptor for write operation
err	Davix Error report

Returns

total number of bytes read, or -1 if error occures

dav_ssize_t Davix::DavFile::getToFd	(	const RequestParams *	params,
		int	fd,
		dav_size_t	size_read,
		DavixError **	err
	)

Get the first 'size_read' bytes of the file and write it to fd.

Parameters

params	Davix request Parameters
fd	file descriptor for write operation
size_read	number of bytes to read
err	Davix Error report

Returns

total number of bytes read, or -1 if error occures

int Davix::DavFile::makeCollection	(	const RequestParams *	params,
		DavixError **	err
	)

create a collection ( directory or bucket) at the current file url

Parameters

params	Davix request Parameters
err	Davix Error report

Returns

0 if success, or -1 if error occures

void Davix::DavFile::prefetchInfo	(	off_t	offset,
		dav_size_t	size_read,
		advise_t	adv
	)

provide informations on the next file operation

provide informations on the next file operations for optimizations and prefetching

Parameters

offset
size_read
adv

int Davix::DavFile::putFromFd	(	const RequestParams *	params,
		int	fd,
		dav_size_t	size_write,
		DavixError **	err
	)

create and replace the file with the content of the file descriptor fd

Parameters

params	Davix request Parameters
fd	file descriptor
size_write	number of bytes to write
err	Davix Error report

Returns

0 if success, or -1 if error occures

dav_ssize_t Davix::DavFile::readPartial	(	const RequestParams *	params,
		void *	buff,
		dav_size_t	count,
		dav_off_t	offset,
		DavixError **	err
	)

Partial position independant read.

   Use Ranged request when supported by the server,
   simulate a ranged request when not  supported

Parameters

params	Davix request Parameters
buff	buffer
count	maximum read size
offset	start offset for the read operation
err	Davix Error report

Returns

total number of bytes read, or -1 if error occures

dav_ssize_t Davix::DavFile::readPartialBufferVec	(	const RequestParams *	params,
		const DavIOVecInput *	input_vec,
		DavIOVecOuput *	ioutput_vec,
		const dav_size_t	count_vec,
		DavixError **	err
	)

Vector read operation Allow to do several read several data chunk in one single operation Use Http multi-part when supported by the server, simulate a vector read operation in the other case.

Parameters

params	Davix request Parameters
input_vec	input vectors, parameters
ioutput_vec	output vectors, results
count_vec	number of vector struct
err	Davix Error report

Returns

total number of bytes read, or -1 if error occures

int Davix::DavFile::stat	(	const RequestParams *	params,
		struct stat *	st,
		DavixError **	err
	)

execute a POSIX-like stat() query

Parameters

params	Davix request Parameters
st	stat struct
err	Davix Error report

Returns

0 if success, or -1 if error occures

---

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

• /build/buildd/davix-0.2.8/include/davix/file/davfile.hpp