Public Member Functions | Protected Member Functions | Friends

sbuild::chroot_plain Class Reference

A chroot located in the filesystem (scripts disabled). 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 chroot::ptr clone_session (std::string const &session_id, std::string const &user, bool root) const
 Create a session chroot.
virtual chroot::ptr clone_source () const
 Create a source 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 session_flags get_session_flags (chroot const &chroot) const
 Get the session flags of the chroot.

Protected Member Functions

 chroot_plain ()
 The constructor.
virtual void setup_lock (chroot::setup_type type, bool lock, int status)
 Unlock a chroot during setup.

Friends

class chroot

Detailed Description

A chroot located in the filesystem (scripts disabled).

This doesn't run any setup scripts and doesn't provide any session support. If you need any of these functions, the directory chroot type is more suited to your needs.


Constructor & Destructor Documentation

chroot_plain::chroot_plain (  )  [protected]

The constructor.

References sbuild::chroot::set_run_setup_scripts().

Referenced by clone().

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.

References chroot_plain().

chroot::ptr sbuild::chroot_plain::clone_session ( std::string const &  session_id,
std::string const &  user,
bool  root 
) const [virtual]

Create a session chroot.

Parameters:
session_id the identifier for the new session.
user the user creating the session.
root true if the user has root access, otherwise false.
Returns:
a session chroot.

Implements sbuild::chroot.

chroot::ptr sbuild::chroot_plain::clone_source (  )  const [virtual]

Create a source chroot.

Returns:
a source 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.

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.

Implements sbuild::chroot.

References sbuild::chroot_directory_base::get_directory().

sbuild::chroot::session_flags chroot_plain::get_session_flags ( chroot const &  chroot  )  const [virtual]

Get the session flags of the chroot.

These determine how the Session controlling the chroot will operate.

Parameters:
chroot the chroot to use.
Returns:
the session flags.

Implements sbuild::chroot.

void chroot_plain::setup_lock ( chroot::setup_type  type,
bool  lock,
int  status 
) [protected, virtual]

Unlock a chroot during setup.

The locking technique (if any) may vary depending upon the chroot type and setup stage. For example, during creation of an LVM snapshot a block device might require locking, but afterwards this will change to the new block device.

An error will be thrown on failure.

Parameters:
type the type of setup being performed
lock true to lock, false to unlock
status the exit status of the setup commands (0 for success, nonzero for failure).

Implements sbuild::chroot.


Friends And Related Function Documentation

friend class chroot [friend]

Reimplemented from sbuild::chroot_directory_base.


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