#include <XrdClRecorder.hh>

Inheritance diagram for XrdCl::Recorder:

Collaboration diagram for XrdCl::Recorder:

[legend]

Classes
class	Output

struct	RecordHandler
	Completion handler recording user action / server response. More...

Public Member Functions
	Recorder ()
	Constructor.

bool	IsValid () const

virtual	~Recorder ()
	Destructor.

virtual XRootDStatus	Open (const std::string &url, OpenFlags::Flags flags, Access::Mode mode, ResponseHandler *handler, uint16_t timeout)
	Open.

virtual XRootDStatus	Close (ResponseHandler *handler, uint16_t timeout)
	Close.

virtual XRootDStatus	Stat (bool force, ResponseHandler *handler, uint16_t timeout)
	Stat.

virtual XRootDStatus	Read (uint64_t offset, uint32_t size, void buffer, ResponseHandler handler, uint16_t timeout)
	Read.

virtual XRootDStatus	Write (uint64_t offset, uint32_t size, const void buffer, ResponseHandler handler, uint16_t timeout)
	Write.

virtual XRootDStatus	PgRead (uint64_t offset, uint32_t size, void buffer, ResponseHandler handler, uint16_t timeout)

virtual XRootDStatus	PgWrite (uint64_t offset, uint32_t size, const void buffer, std::vector< uint32_t > &cksums, ResponseHandler handler, uint16_t timeout)

virtual XRootDStatus	Sync (ResponseHandler *handler, uint16_t timeout)
	Sync.

virtual XRootDStatus	Truncate (uint64_t size, ResponseHandler *handler, uint16_t timeout)
	Truncate.

virtual XRootDStatus	VectorRead (const ChunkList &chunks, void buffer, ResponseHandler handler, uint16_t timeout)
	VectorRead.

virtual XRootDStatus	VectorWrite (const ChunkList &chunks, ResponseHandler *handler, uint16_t timeout)
	VectorRead.

virtual XRootDStatus	Fcntl (const Buffer &arg, ResponseHandler *handler, uint16_t timeout)
	Fcntl.

virtual XRootDStatus	Visa (ResponseHandler *handler, uint16_t timeout)
	Visa.

virtual bool	IsOpen () const
	IsOpen.

virtual bool	SetProperty (const std::string &name, const std::string &value)
	SetProperty.

virtual bool	GetProperty (const std::string &name, std::string &value) const
	GetProperty.

Public Member Functions inherited from XrdCl::FilePlugIn
virtual	~FilePlugIn ()
	Destructor.

virtual XRootDStatus	Read (uint64_t offset, uint32_t size, Optional< uint64_t > fdoff, int fd, ResponseHandler *handler, uint16_t timeout=0)

virtual XRootDStatus	Write (uint64_t offset, Buffer &&buffer, ResponseHandler *handler, uint16_t timeout=0)

virtual XRootDStatus	Write (uint64_t offset, uint32_t size, Optional< uint64_t > fdoff, int fd, ResponseHandler *handler, uint16_t timeout=0)

virtual XRootDStatus	WriteV (uint64_t offset, const struct iovec iov, int iovcnt, ResponseHandler handler, uint16_t timeout=0)

Static Public Member Functions
static void	SetOutput (const std::string &cfgpath)

Private Attributes
File	file

Output &	output

Detailed Description

XrdClFile plugin that arecords all user actions and server responses and dumps the data into a csv file.

Constructor & Destructor Documentation

◆ Recorder()

XrdCl::Recorder::Recorder ( )

inline

Constructor.

◆ ~Recorder()

virtual XrdCl::Recorder::~Recorder ( )

inlinevirtual

Destructor.

Member Function Documentation

◆ Close()

virtual XRootDStatus XrdCl::Recorder::Close	(	ResponseHandler *	handler,
		uint16_t	timeout
	)

inlinevirtual

Close.

Reimplemented from XrdCl::FilePlugIn.

References XrdCl::File::Close(), file, and output.

◆ Fcntl()

virtual XRootDStatus XrdCl::Recorder::Fcntl	(	const Buffer &	arg,
		ResponseHandler *	handler,
		uint16_t	timeout
	)

inlinevirtual

Fcntl.

Reimplemented from XrdCl::FilePlugIn.

References XrdCl::File::Fcntl(), file, and output.

◆ GetProperty()

virtual bool XrdCl::Recorder::GetProperty	(	const std::string &	name,
		std::string &	value
	)		const

inlinevirtual

GetProperty.

Reimplemented from XrdCl::FilePlugIn.

References file, and XrdCl::File::GetProperty().

◆ IsOpen()

virtual bool XrdCl::Recorder::IsOpen ( ) const

inlinevirtual

IsOpen.

Reimplemented from XrdCl::FilePlugIn.

References file, and XrdCl::File::IsOpen().

◆ IsValid()

bool XrdCl::Recorder::IsValid ( ) const

inline

Returns: : true if this is a valid instance, false otherwise

References XrdCl::Recorder::Output::IsValid(), and output.

◆ Open()

virtual XRootDStatus XrdCl::Recorder::Open	(	const std::string &	url,
		OpenFlags::Flags	flags,
		Access::Mode	mode,
		ResponseHandler *	handler,
		uint16_t	timeout
	)

inlinevirtual

Open.

Reimplemented from XrdCl::FilePlugIn.

References file, XrdCl::File::Open(), and output.

◆ PgRead()

virtual XRootDStatus XrdCl::Recorder::PgRead	(	uint64_t	offset,
		uint32_t	size,
		void *	buffer,
		ResponseHandler *	handler,
		uint16_t	timeout
	)

inlinevirtual

See also: XrdCl:File PgRead

Reimplemented from XrdCl::FilePlugIn.

References file, output, and XrdCl::File::PgRead().

◆ PgWrite()

virtual XRootDStatus XrdCl::Recorder::PgWrite	(	uint64_t	offset,
		uint32_t	size,
		const void *	buffer,
		std::vector< uint32_t > &	cksums,
		ResponseHandler *	handler,
		uint16_t	timeout
	)

inlinevirtual

See also: XrdCl::File::PgWrite

Reimplemented from XrdCl::FilePlugIn.

References file, output, and XrdCl::File::PgWrite().

◆ Read()

virtual XRootDStatus XrdCl::Recorder::Read	(	uint64_t	offset,
		uint32_t	size,
		void *	buffer,
		ResponseHandler *	handler,
		uint16_t	timeout
	)

inlinevirtual

Read.

Reimplemented from XrdCl::FilePlugIn.

References file, output, and XrdCl::File::Read().

◆ SetOutput()

static void XrdCl::Recorder::SetOutput ( const std::string & cfgpath )

inlinestatic

Create the output csv file

Parameters

cfgpath : path for the file to be created

References XrdCl::Recorder::Output::Get(), and XrdCl::Recorder::Output::SetPath().

Referenced by XrdCl::RecorderFactory::RecorderFactory().

◆ SetProperty()

virtual bool XrdCl::Recorder::SetProperty	(	const std::string &	name,
		const std::string &	value
	)

inlinevirtual

SetProperty.

Reimplemented from XrdCl::FilePlugIn.

References file, and XrdCl::File::SetProperty().

◆ Stat()

virtual XRootDStatus XrdCl::Recorder::Stat	(	bool	force,
		ResponseHandler *	handler,
		uint16_t	timeout
	)

inlinevirtual

Stat.

Reimplemented from XrdCl::FilePlugIn.

References file, output, and XrdCl::File::Stat().

◆ Sync()

virtual XRootDStatus XrdCl::Recorder::Sync	(	ResponseHandler *	handler,
		uint16_t	timeout
	)

inlinevirtual

Sync.

Reimplemented from XrdCl::FilePlugIn.

References file, output, and XrdCl::File::Sync().

◆ Truncate()

virtual XRootDStatus XrdCl::Recorder::Truncate	(	uint64_t	size,
		ResponseHandler *	handler,
		uint16_t	timeout
	)

inlinevirtual

Truncate.

Reimplemented from XrdCl::FilePlugIn.

References file, output, and XrdCl::File::Truncate().

◆ VectorRead()

virtual XRootDStatus XrdCl::Recorder::VectorRead	(	const ChunkList &	chunks,
		void *	buffer,
		ResponseHandler *	handler,
		uint16_t	timeout
	)

inlinevirtual

VectorRead.

Reimplemented from XrdCl::FilePlugIn.

References file, output, and XrdCl::File::VectorRead().

◆ VectorWrite()

virtual XRootDStatus XrdCl::Recorder::VectorWrite	(	const ChunkList &	chunks,
		ResponseHandler *	handler,
		uint16_t	timeout
	)

inlinevirtual

VectorRead.

Reimplemented from XrdCl::FilePlugIn.

References file, output, and XrdCl::File::VectorWrite().

◆ Visa()

virtual XRootDStatus XrdCl::Recorder::Visa	(	ResponseHandler *	handler,
		uint16_t	timeout
	)

inlinevirtual

Visa.

Reimplemented from XrdCl::FilePlugIn.

References file, and XrdCl::File::Visa().

◆ Write()

virtual XRootDStatus XrdCl::Recorder::Write	(	uint64_t	offset,
		uint32_t	size,
		const void *	buffer,
		ResponseHandler *	handler,
		uint16_t	timeout
	)

inlinevirtual

Write.

Reimplemented from XrdCl::FilePlugIn.

References file, output, and XrdCl::File::Write().

Member Data Documentation

◆ file

File XrdCl::Recorder::file

private

Referenced by Close(), Fcntl(), GetProperty(), IsOpen(), Open(), PgRead(), PgWrite(), Read(), SetProperty(), Stat(), Sync(), Truncate(), VectorRead(), VectorWrite(), Visa(), and Write().

◆ output

Output& XrdCl::Recorder::output

private

Referenced by Close(), Fcntl(), XrdCl::Recorder::Output::Get(), XrdCl::Recorder::Output::Instance(), IsValid(), Open(), PgRead(), PgWrite(), Read(), Stat(), Sync(), Truncate(), VectorRead(), VectorWrite(), and Write().

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

XrdClRecorder.hh

Classes

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Recorder()

◆ ~Recorder()

Member Function Documentation

◆ Close()

◆ Fcntl()

◆ GetProperty()

◆ IsOpen()

◆ IsValid()

◆ Open()

◆ PgRead()

◆ PgWrite()

◆ Read()

◆ SetOutput()

◆ SetProperty()

◆ Stat()

◆ Sync()

◆ Truncate()

◆ VectorRead()

◆ VectorWrite()

◆ Visa()

◆ Write()

Member Data Documentation

◆ file

◆ output