Dobby  3.0
Dobby “Docker based Thingy” is a tool for managing and running OCI containers using crun
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Minidump Class Reference

Dobby RDK Minidump Plugin. More...

#include <Minidump.h>

Inheritance diagram for Minidump:
Inheritance graph
[legend]
Collaboration diagram for Minidump:
Collaboration graph
[legend]

Public Member Functions

 Minidump (std::shared_ptr< rt_dobby_schema > &containerConfig, const std::shared_ptr< DobbyRdkPluginUtils > &utils, const std::string &rootfsPath)
 Constructor - called when plugin is loaded by PluginLauncher. More...
 
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
 OCI Hook - Run in host namespace.
 
bool postHalt () override
 Dobby Hook - Run in host namespace when container terminates.
 
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 postStop ()
 

Private Member Functions

std::string getDestinationFile ()
 Creates a target location for the file where minidumps will be loaded. More...
 

Private Attributes

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

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...
 

Detailed Description

Dobby RDK Minidump Plugin.

Manages collection of minidump core files located in container namespace

Constructor & Destructor Documentation

◆ Minidump()

Minidump::Minidump ( std::shared_ptr< rt_dobby_schema > &  containerConfig,
const std::shared_ptr< DobbyRdkPluginUtils > &  utils,
const std::string &  rootfsPath 
)

Constructor - called when plugin is loaded by PluginLauncher.

Do not change the parameters for this constructor - must match C methods created by REGISTER_RDK_PLUGIN macro

Note plugin name is not case sensitive

Member Function Documentation

◆ getDependencies()

std::vector< std::string > Minidump::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.

◆ getDestinationFile()

std::string Minidump::getDestinationFile ( )
private

Creates a target location for the file where minidumps will be loaded.

It consist of:

  • destination path (/opt/minidumps or /opt/secure/minidumps) from config.json
  • container id (e.g. "de.sky.ZDF")
  • extension *.dmp
Returns
Destination minidump file path string

◆ name()

std::string Minidump::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: