roo_monitoring::VaultWriter Class Reference

Writes vault files for a collection at a specific resolution. More...

#include <compaction.h>

Public Member Functions
	VaultWriter (Collection *collection, VaultFileRef ref)
	Creates a writer for the given collection and vault file.
const VaultFileRef &	vault_ref () const
	Returns the reference to the vault file being written.
roo_io::Status	openNew ()
	Opens a new vault file for writing.
roo_io::Status	openExisting (int write_index)
	Opens an existing vault file, seeking to the specified entry index.
void	close ()
	Closes the underlying writer.
int	write_index () const
	Returns the current write index within the vault file.
void	writeEmptyData ()
	Writes an empty vault file payload.
void	writeLogData (const std::vector< LogSample > &data)
	Writes raw log samples into the vault file.
void	writeAggregatedData (const Aggregator &aggregator)
	Writes aggregated samples into the vault file.
bool	ok () const
	Returns true if the writer is in a good state.
roo_io::Status	status () const
	Returns the current writer status.

Detailed Description

Writes vault files for a collection at a specific resolution.

Definition at line 39 of file compaction.h.

Constructor & Destructor Documentation

VaultWriter()

roo_monitoring::VaultWriter::VaultWriter	(	Collection *	collection,
		VaultFileRef	ref
	)

Creates a writer for the given collection and vault file.

Definition at line 40 of file compaction.cpp.

Member Function Documentation

close()

void roo_monitoring::VaultWriter::close ( )

inline

Closes the underlying writer.

Definition at line 53 of file compaction.h.

ok()

bool roo_monitoring::VaultWriter::ok ( ) const

inline

Returns true if the writer is in a good state.

Definition at line 68 of file compaction.h.

openExisting()

roo_io::Status roo_monitoring::VaultWriter::openExisting

(

int

write_index

)

Opens an existing vault file, seeking to the specified entry index.

Definition at line 64 of file compaction.cpp.

References roo_monitoring::Collection::fs(), roo_monitoring::Collection::getVaultFilePath(), roo_monitoring::kRangeElementCount, and write_index().

openNew()

roo_io::Status roo_monitoring::VaultWriter::openNew

(

)

Opens a new vault file for writing.

Definition at line 43 of file compaction.cpp.

References roo_monitoring::Collection::fs(), and roo_monitoring::Collection::getVaultFilePath().

status()

roo_io::Status roo_monitoring::VaultWriter::status ( ) const

inline

Returns the current writer status.

Definition at line 71 of file compaction.h.

vault_ref()

const VaultFileRef & roo_monitoring::VaultWriter::vault_ref ( ) const

inline

Returns the reference to the vault file being written.

Definition at line 44 of file compaction.h.

write_index()

int roo_monitoring::VaultWriter::write_index ( ) const

inline

Returns the current write index within the vault file.

Definition at line 56 of file compaction.h.

Referenced by openExisting().

writeAggregatedData()

void roo_monitoring::VaultWriter::writeAggregatedData

(

const Aggregator &

aggregator

)

Writes aggregated samples into the vault file.

Definition at line 114 of file compaction.cpp.

References roo_monitoring::kRangeElementCount.

writeEmptyData()

void roo_monitoring::VaultWriter::writeEmptyData

(

)

Writes an empty vault file payload.

Definition at line 82 of file compaction.cpp.

References roo_monitoring::kRangeElementCount.

writeLogData()

void roo_monitoring::VaultWriter::writeLogData

(

const std::vector< LogSample > &

data

)

Writes raw log samples into the vault file.

Definition at line 92 of file compaction.cpp.

References roo_monitoring::kRangeElementCount.

---

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

• temp_repos/roo_monitoring/src/roo_monitoring/compaction.h
• temp_repos/roo_monitoring/src/roo_monitoring/compaction.cpp