this objects is a thread object that provide access to the content of an existing archive More...

#include <archive_init_list.hpp>

Inheritance diagram for archive_init_list:

Collaboration diagram for archive_init_list:

Public Member Functions
	archive_init_list (const archive_init_list &ref)=delete

	archive_init_list (archive_init_list &&ref) noexcept=delete

archive_init_list &	operator= (const archive_init_list &ref)=delete

archive_init_list &	operator= (archive_init_list &&ref) noexcept=delete

void	set_user_interaction (std::shared_ptr< html_web_user_interaction > ref)
	set the user interaction to report on when running the thread

void	set_parametrage (const saisie *x_param)

bool	opened () const

const std::vector< libdar::list_entry >	get_children_in_table (const std::string &dir) const
	obtains contents from the opened archive in the calling thread

bool	has_subdirectory (const std::string &dir) const

libdar::archive_summary	get_summary () const
	obtain the archive summary

std::string	get_archive_full_name () const

void	close_archive ()
	close the opened archive run in the calling thread

Protected Member Functions
virtual void	inherited_run () override
	inherited from class libthreadar::thread

virtual void	signaled_inherited_cancel () override
	inherited from libthreadar::thread

Detailed Description

this objects is a thread object that provide access to the content of an existing archive

the object must first be set with the location of the dar archive to open using set_archive_path(), set_archive_basename() and eventually set_archive_options_read() then the thread has to be run calling the libthreadar::run() inherited method which opens the archive. Once the archive has been openned successfully the thread ends and the method openned() returns true. Starting this point, the archive content is available calling get_children_in_table() or has_subdirectory(). Once completed close_archive() can be called or the object deleted.

Member Function Documentation

◆ opened()

bool archive_init_list::opened ( ) const

inline

once the thread has been ran and has finished, we end up with an opened archive

Returns: true if the archive is available false if a failure occured and no archive available

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

archive_init_list.hpp
archive_init_list.cpp

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ opened()