smartmontools SVN Rev 5617
Utility to control and monitor storage systems with "S.M.A.R.T."
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
tunnelled_device< BaseDev, TunnelDev > Class Template Reference

Implement a device by tunneling through another device. More...

#include <dev_tunnelled.h>

Collaboration diagram for tunnelled_device< BaseDev, TunnelDev >:
Collaboration graph
[legend]

Public Types

typedef TunnelDev tunnel_device_type
 

Public Member Functions

virtual void release (const smart_device *dev) override
 Release ownership of other device.
 
tunnel_device_typeget_tunnel_dev ()
 
const tunnel_device_typeget_tunnel_dev () const
 
- Public Member Functions inherited from tunnelled_device_base
virtual ~tunnelled_device_base ()
 
virtual bool is_open () const override
 Return true if device is open.
 
virtual bool open () override
 Open device, return false on error.
 
virtual bool close () override
 Close device, return false on error.
 
virtual bool owns (const smart_device *dev) const override
 Return true if other device is owned by this device.
 
virtual void release (const smart_device *dev) override
 Release ownership of other device.
 
- Public Member Functions inherited from smart_device
virtual ~smart_device ()
 
bool is_ata () const
 Return true if ATA device.
 
bool is_scsi () const
 Return true if SCSI device.
 
bool is_nvme () const
 Return true if NVMe device.
 
ata_deviceto_ata ()
 Downcast to ATA device.
 
const ata_deviceto_ata () const
 Downcast to ATA device (const).
 
scsi_deviceto_scsi ()
 Downcast to SCSI device.
 
const scsi_deviceto_scsi () const
 Downcast to SCSI device (const).
 
nvme_deviceto_nvme ()
 Downcast to NVMe device.
 
const nvme_deviceto_nvme () const
 Downcast to NVMe device (const).
 
const device_infoget_info () const
 Get device info struct.
 
const char * get_dev_name () const
 Get device (path)name.
 
const char * get_info_name () const
 Get informal name.
 
const char * get_dev_type () const
 Get device type.
 
const char * get_req_type () const
 Get type requested by user, empty if none.
 
const error_infoget_err () const
 Get last error info struct.
 
int get_errno () const
 Get last error number.
 
const char * get_errmsg () const
 Get last error message.
 
virtual bool is_syscall_unsup () const
 Return true if last error indicates an unsupported system call.
 
bool set_err (int no, const char *msg,...) __attribute_format_printf(3
 Set last error number and message.
 
bool bool set_err (const error_info &err)
 Set last error info struct.
 
void clear_err ()
 Clear last error info.
 
bool set_err (int no)
 Set last error number and default message.
 
virtual bool is_open () const =0
 Return true if device is open.
 
virtual bool open ()=0
 Open device, return false on error.
 
virtual bool close ()=0
 Close device, return false on error.
 
virtual smart_deviceautodetect_open ()
 Open device with autodetection support.
 
virtual bool is_powered_down ()
 Early test if device is powered up or down.
 
virtual bool owns (const smart_device *dev) const
 Return true if other device is owned by this device.
 
virtual void release (const smart_device *dev)
 Release ownership of other device.
 

Protected Member Functions

 tunnelled_device (tunnel_device_type *tunnel_dev)
 
 tunnelled_device (tunnel_device_type *tunnel_dev, unsigned nsid)
 
- Protected Member Functions inherited from tunnelled_device_base
 tunnelled_device_base (smart_device *tunnel_dev)
 
- Protected Member Functions inherited from smart_device
 smart_device (smart_interface *intf, const char *dev_name, const char *dev_type, const char *req_type)
 Constructor to init interface and device info.
 
 smart_device (do_not_use_in_implementation_classes)
 Dummy constructor for abstract classes.
 
device_infoset_info ()
 R/W access to device info struct.
 
smart_interfacesmi ()
 Get interface which produced this object.
 
const smart_interfacesmi () const
 Get interface which produced this object (const).
 

Private Attributes

tunnel_device_typem_tunnel_dev
 

Additional Inherited Members

- Static Public Member Functions inherited from smart_device
static int get_num_objects ()
 Get current number of allocated 'smart_device' objects.
 
- Protected Types inherited from smart_device
enum  do_not_use_in_implementation_classes { never_called }
 Dummy enum for dummy constructor. More...
 

Detailed Description

template<class BaseDev, class TunnelDev>
class tunnelled_device< BaseDev, TunnelDev >

Implement a device by tunneling through another device.

Definition at line 53 of file dev_tunnelled.h.

Member Typedef Documentation

◆ tunnel_device_type

template<class BaseDev , class TunnelDev >
typedef TunnelDev tunnelled_device< BaseDev, TunnelDev >::tunnel_device_type

Definition at line 58 of file dev_tunnelled.h.

Constructor & Destructor Documentation

◆ tunnelled_device() [1/2]

template<class BaseDev , class TunnelDev >
tunnelled_device< BaseDev, TunnelDev >::tunnelled_device ( tunnel_device_type tunnel_dev)
inlineexplicitprotected

Definition at line 61 of file dev_tunnelled.h.

◆ tunnelled_device() [2/2]

template<class BaseDev , class TunnelDev >
tunnelled_device< BaseDev, TunnelDev >::tunnelled_device ( tunnel_device_type tunnel_dev,
unsigned  nsid 
)
inlineexplicitprotected

Definition at line 68 of file dev_tunnelled.h.

Member Function Documentation

◆ get_tunnel_dev() [1/2]

template<class BaseDev , class TunnelDev >
tunnel_device_type * tunnelled_device< BaseDev, TunnelDev >::get_tunnel_dev ( )
inline

Definition at line 83 of file dev_tunnelled.h.

◆ get_tunnel_dev() [2/2]

template<class BaseDev , class TunnelDev >
const tunnel_device_type * tunnelled_device< BaseDev, TunnelDev >::get_tunnel_dev ( ) const
inline

Definition at line 86 of file dev_tunnelled.h.

◆ release()

template<class BaseDev , class TunnelDev >
virtual void tunnelled_device< BaseDev, TunnelDev >::release ( const smart_device dev)
inlineoverridevirtual

Release ownership of other device.

Default implementation does nothing.

Reimplemented from tunnelled_device_base.

Definition at line 76 of file dev_tunnelled.h.

Member Data Documentation

◆ m_tunnel_dev

template<class BaseDev , class TunnelDev >
tunnel_device_type* tunnelled_device< BaseDev, TunnelDev >::m_tunnel_dev
private

Definition at line 90 of file dev_tunnelled.h.


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