Dobby  3.0
Dobby “Docker based Thingy” is a tool for managing and running OCI containers using crun
Classes | Public Member Functions | Private Member Functions | Private Attributes | List of all members
DeviceMapperPlugin Class Reference
Inheritance diagram for DeviceMapperPlugin:
Inheritance graph
[legend]
Collaboration diagram for DeviceMapperPlugin:
Collaboration graph
[legend]

Classes

struct  DevNode
 

Public Member Functions

 DeviceMapperPlugin (std::shared_ptr< rt_dobby_schema > &containerConfig, const std::shared_ptr< DobbyRdkPluginUtils > &utils, const std::string &rootfsPath)
 
std::string name () const override
 Should return the name of the plugin. More...
 
unsigned hookHints () const override
 Set the bit flags for which hooks we're going to use.
 
bool preCreation () override
 Dobby Hook - run in host namespace before container creation process.
 
std::vector< std::string > getDependencies () const override
 Should return the names of the plugins this plugin depends on. More...
 
- Public Member Functions inherited from RdkPluginBase
virtual bool postInstallation ()
 
virtual bool createRuntime ()
 
virtual bool createContainer ()
 
virtual bool postStart ()
 
virtual bool postHalt ()
 
virtual bool postStop ()
 

Private Member Functions

bool getDevNodeFromPath (const std::string &path, DevNode &node)
 Gets the actual details about the device node (major/minor ids) at a given path. More...
 

Private Attributes

const std::string mName
 
std::shared_ptr< rt_dobby_schema > mContainerConfig
 
const std::string mRootfsPath
 
const std::shared_ptr< DobbyRdkPluginUtilsmUtils
 
bool mValid
 

Additional Inherited Members

- Public Types inherited from IDobbyRdkPlugin
enum  HintFlags : unsigned {
  PostInstallationFlag = (1 << 0) , PreCreationFlag = (1 << 1) , CreateRuntimeFlag = (1 << 2) , CreateContainerFlag = (1 << 3) ,
  PostStartFlag = (1 << 5) , PostHaltFlag = (1 << 6) , PostStopFlag = (1 << 7) , Unknown = 0
}
 Bit flags that should be returned by hookHints. More...
 

Member Function Documentation

◆ getDependencies()

std::vector< std::string > DeviceMapperPlugin::getDependencies ( ) const
overridevirtual

Should return the names of the plugins this plugin depends on.

This can be used to determine the order in which the plugins should be processed when running hooks.

Returns
Names of the plugins this plugin depends on.

Reimplemented from RdkPluginBase.

◆ getDevNodeFromPath()

bool DeviceMapperPlugin::getDevNodeFromPath ( const std::string &  path,
DeviceMapperPlugin::DevNode node 
)
private

Gets the actual details about the device node (major/minor ids) at a given path.

Parameters
[in]pathThe path of the device
[out]nodeThe details about the device
Returns
True if device node details got successfully

◆ name()

std::string DeviceMapperPlugin::name ( ) const
inlineoverridevirtual

Should return the name of the plugin.

Returns
string with the name of the hook.

Implements IDobbyRdkPlugin.


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