sbuild::chroot_plain Class Reference

A chroot located on a mounted filesystem. More...

#include <sbuild-chroot-plain.h>

Inheritance diagram for sbuild::chroot_plain:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual ~chroot_plain ()
 The destructor.
virtual chroot::ptr clone () const
 Copy the chroot.
virtual std::string const & get_location () const
 Get the directory location of the chroot.
virtual void set_location (std::string const &location)
 Set the directory location of the chroot.
virtual std::string get_path () const
 Get the path to 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_plain ()
 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.

Friends

class chroot

Detailed Description

A chroot located on a mounted filesystem.


Constructor & Destructor Documentation

chroot_plain::chroot_plain  )  [protected]
 

The constructor.

chroot_plain::~chroot_plain  )  [virtual]
 

The destructor.


Member Function Documentation

sbuild::chroot::ptr chroot_plain::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.

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

Get the type of the chroot.

Returns:
the chroot type.

Implements sbuild::chroot.

void chroot_plain::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.

std::string const & chroot_plain::get_location  )  const [virtual]
 

Get the directory location of the chroot.

Returns:
the location.

Reimplemented from sbuild::chroot.

std::string chroot_plain::get_path  )  const [virtual]
 

Get the path to the chroot.

This is the absolute path to the root of the chroot, and is typically the same as the mount location and location concatenated together, but is overridden by the chroot type if required.

Returns:
the path.

Reimplemented from sbuild::chroot.

sbuild::chroot::session_flags chroot_plain::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_plain::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.

void chroot_plain::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.

void chroot_plain::set_location std::string const &  location  )  [virtual]
 

Set the directory location of the chroot.

Parameters:
location the location.

Reimplemented from sbuild::chroot.

void chroot_plain::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.

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


Friends And Related Function Documentation

friend class chroot [friend]
 


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