sbuild::chroot_file Class Reference

A chroot stored in a file archive (tar or zip). More...

#include <sbuild-chroot-file.h>

Inheritance diagram for sbuild::chroot_file:

Inheritance graph
[legend]
Collaboration diagram for sbuild::chroot_file:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual ~chroot_file ()
 The destructor.
virtual chroot::ptr clone () const
 Copy the chroot.
virtual chroot::ptr clone_source () const
std::string const & get_file () const
 Get the file used by the chroot.
void set_file (std::string const &file)
 Set the file used by the chroot.
virtual std::string const & get_chroot_type () const
 Get the type of the chroot.
virtual void setup_env (environment &env)
 Set environment.
virtual void setup_lock (setup_type type, bool lock)
virtual session_flags get_session_flags () const
 Get the session flags of the chroot.

Protected Member Functions

 chroot_file ()
 The constructor.
virtual void print_details (std::ostream &stream) const
 Print detailed information about the chroot to a stream.
virtual void get_keyfile (keyfile &keyfile) const
 Copy the chroot properties into a keyfile.
virtual void set_keyfile (keyfile const &keyfile)
 Set the chroot properties from a keyfile.

Private Attributes

std::string file
 The file to use.
bool repack
 Should the chroot be repacked?

Friends

class chroot

Detailed Description

A chroot stored in a file archive (tar or zip).

The archive will be unpacked on demand.

Todo:
Optionally mount and then unpack onto a tmpfs, to save using a lot of space under /var. However, this will require careful checking and/or restrictions in order to prevent resource starvation (using all swap space, for example).


Constructor & Destructor Documentation

chroot_file::chroot_file  )  [protected]
 

The constructor.

chroot_file::~chroot_file  )  [virtual]
 

The destructor.


Member Function Documentation

sbuild::chroot::ptr chroot_file::clone  )  const [virtual]
 

Copy the chroot.

This is a virtual copy constructor.

Returns:
a shared_ptr to the new copy of the chroot.

Implements sbuild::chroot.

sbuild::chroot::ptr chroot_file::clone_source  )  const [virtual]
 

Implements sbuild::chroot_source.

std::string const & chroot_file::get_chroot_type  )  const [virtual]
 

Get the type of the chroot.

Returns:
the chroot type.

Implements sbuild::chroot.

std::string const & chroot_file::get_file  )  const
 

Get the file used by the chroot.

Returns:
the file.

void chroot_file::get_keyfile keyfile keyfile  )  const [protected, virtual]
 

Copy the chroot properties into a keyfile.

The keyfile group with the name of the chroot will be set; if it already exists, it will be removed before setting it.

Parameters:
keyfile the keyfile to use.

Reimplemented from sbuild::chroot_source.

sbuild::chroot::session_flags chroot_file::get_session_flags  )  const [virtual]
 

Get the session flags of the chroot.

These determine how the Session controlling the chroot will operate.

Returns:
the session flags.

Implements sbuild::chroot.

void chroot_file::print_details std::ostream &  stream  )  const [protected, virtual]
 

Print detailed information about the chroot to a stream.

The information is printed in plain text with one line per property.

Parameters:
stream the stream to output to.

Reimplemented from sbuild::chroot_source.

void chroot_file::set_file std::string const &  file  ) 
 

Set the file used by the chroot.

Parameters:
file the file.

void chroot_file::set_keyfile keyfile const &  keyfile  )  [protected, virtual]
 

Set the chroot properties from a keyfile.

The chroot name must have previously been set, so that the correct keyfile group may be determined.

Parameters:
keyfile the keyfile to get the properties from.

Reimplemented from sbuild::chroot_source.

void chroot_file::setup_env environment env  )  [virtual]
 

Set environment.

Set the environment that the setup scripts will see during execution.

Parameters:
env the environment to set.

Reimplemented from sbuild::chroot_source.

void chroot_file::setup_lock setup_type  type,
bool  lock
[virtual]
 


Friends And Related Function Documentation

friend class chroot [friend]
 

Reimplemented from sbuild::chroot_source.


Member Data Documentation

std::string sbuild::chroot_file::file [private]
 

The file to use.

bool sbuild::chroot_file::repack [private]
 

Should the chroot be repacked?


The documentation for this class was generated from the following files:
Generated on Sun Mar 19 12:08:52 2006 for schroot by  doxygen 1.4.6