RDK Documentation (Open Sourced RDK Components)
Functions
TR-069 Object (Device.StorageService.PhysicalMedium.Interface.{i}) Public APIs
TR-069 » TR-069 Host Interface » TR-069 Host Interface Profile » TR-069 Object (Device.StorageService) » TR-069 Object (Device.StorageService.PhysicalMedium.Interface)

Description

Describe the details about RDK TR069 storage service physical medium APIs specifications.

Functions

void hostIf_PhysicalMedium::getLock ()
 This function get the lock before setting or getting the attributes of the host interface physical medium.
 
void hostIf_PhysicalMedium::releaseLock ()
 This function use to release the lock before setting or getting the attributes of the host interface physical medium.
 
int hostIf_PhysicalMedium::get_Device_Service_StorageMedium_Name (HOSTIF_MsgData_t *stMsgData)
 This function get the name of the storage service medium. More...
 
int hostIf_PhysicalMedium::get_Device_Service_StorageMedium_Health (HOSTIF_MsgData_t *stMsgData)
 This function get the health of the storage service medium. More...
 
int hostIf_PhysicalMedium::get_Device_Service_StorageMedium_SMARTCapable (HOSTIF_MsgData_t *stMsgData)
 This function get the SMART capability of the storage service medium. More...
 
int hostIf_PhysicalMedium::get_Device_Service_StorageMedium_Alias (HOSTIF_MsgData_t *stMsgData)
 This function get the alias of storage service medium. Currently not implemented. More...
 
int hostIf_PhysicalMedium::get_Device_Service_StorageMedium_Vendor (HOSTIF_MsgData_t *stMsgData)
 This function get the vendor of the storage service medium. Currently not implemented. More...
 
int hostIf_PhysicalMedium::get_Device_Service_StorageMedium_Model (HOSTIF_MsgData_t *stMsgData)
 This function get the model number of the storage service medium. Currently not implemented. More...
 
int hostIf_PhysicalMedium::get_Device_Service_StorageMedium_SerialNumber (HOSTIF_MsgData_t *stMsgData)
 This function get the serial number of the storage service medium. Currently not implemented. More...
 
int hostIf_PhysicalMedium::get_Device_Service_StorageMedium_FirmwareVersion (HOSTIF_MsgData_t *stMsgData)
 This function get the firmware version of the storage service medium. Currently not implemented. More...
 
int hostIf_PhysicalMedium::get_Device_Service_StorageMedium_ConnectionType (HOSTIF_MsgData_t *stMsgData)
 This function get the connection type of the storage service medium. Currently not implemented. More...
 
int hostIf_PhysicalMedium::get_Device_Service_StorageMedium_Removable (HOSTIF_MsgData_t *stMsgData)
 This function get the storage service medium removable. Currently not implemented. More...
 
int hostIf_PhysicalMedium::get_Device_Service_StorageMedium_Status (HOSTIF_MsgData_t *stMsgData)
 This function get the status of the storage service medium. Currently not implemented. More...
 
int hostIf_PhysicalMedium::get_Device_Service_StorageMedium_Uptime (HOSTIF_MsgData_t *stMsgData)
 This function get the uptime of the storage service medium. Currently not implemented. More...
 
int hostIf_PhysicalMedium::get_Device_Service_StorageMedium_HotSwappable (HOSTIF_MsgData_t *stMsgData)
 This function get the storage service medium hot swappable. Currently not implemented. More...
 

Function Documentation

◆ get_Device_Service_StorageMedium_Name()

int hostIf_PhysicalMedium::get_Device_Service_StorageMedium_Name ( HOSTIF_MsgData_t *  stMsgData)

This function get the name of the storage service medium.

Parameters
[in]stMsgDataHostIf Message Request param contains the storage medium attribute value.
Returns
Returns an Integer value.
Return values
0If successfully get the hostIf storage medium interface attribute.
-1If Not able to get the hostIf storage medium interface attribute.
-2If Not handle the hostIf storage medium interface attribute.

Definition at line 276 of file Service_Storage_PhyMedium.cpp.

◆ get_Device_Service_StorageMedium_Health()

int hostIf_PhysicalMedium::get_Device_Service_StorageMedium_Health ( HOSTIF_MsgData_t *  stMsgData)

This function get the health of the storage service medium.

Parameters
[in]stMsgDataHostIf Message Request param contains the storage medium attribute value.
Returns
Returns an Integer value.
Return values
0If successfully get the hostIf storage medium interface attribute.
-1If Not able to get the hostIf storage medium interface attribute.
-2If Not handle the hostIf storage medium interface attribute.

Definition at line 300 of file Service_Storage_PhyMedium.cpp.

◆ get_Device_Service_StorageMedium_SMARTCapable()

int hostIf_PhysicalMedium::get_Device_Service_StorageMedium_SMARTCapable ( HOSTIF_MsgData_t *  stMsgData)

This function get the SMART capability of the storage service medium.

Parameters
[in]stMsgDataHostIf Message Request param contains the storage medium attribute value.
Returns
Returns an Integer value.
Return values
0If successfully get the hostIf storage medium interface attribute.
-1If Not able to get the hostIf storage medium interface attribute.
-2If Not handle the hostIf storage medium interface attribute.

Definition at line 324 of file Service_Storage_PhyMedium.cpp.

◆ get_Device_Service_StorageMedium_Alias()

int hostIf_PhysicalMedium::get_Device_Service_StorageMedium_Alias ( HOSTIF_MsgData_t *  stMsgData)

This function get the alias of storage service medium. Currently not implemented.

Parameters
[in]stMsgDataHostIf Message Request param contains the storage medium attribute value.
Returns
Returns an Integer value.
Return values
0If successfully get the hostIf storage medium interface attribute.
-1If Not able to get the hostIf storage medium interface attribute.
-2If Not handle the hostIf storage medium interface attribute.

Definition at line 348 of file Service_Storage_PhyMedium.cpp.

◆ get_Device_Service_StorageMedium_Vendor()

int hostIf_PhysicalMedium::get_Device_Service_StorageMedium_Vendor ( HOSTIF_MsgData_t *  stMsgData)

This function get the vendor of the storage service medium. Currently not implemented.

Parameters
[in]stMsgDataHostIf Message Request param contains the storage medium attribute value.
Returns
Returns an Integer value.
Return values
0If successfully get the hostIf storage medium interface attribute.
-1If Not able to get the hostIf storage medium interface attribute.
-2If Not handle the hostIf storage medium interface attribute.

Definition at line 366 of file Service_Storage_PhyMedium.cpp.

◆ get_Device_Service_StorageMedium_Model()

int hostIf_PhysicalMedium::get_Device_Service_StorageMedium_Model ( HOSTIF_MsgData_t *  stMsgData)

This function get the model number of the storage service medium. Currently not implemented.

Parameters
[in]stMsgDataHostIf Message Request param contains the storage medium attribute value.
Returns
Returns an Integer value.
Return values
0If successfully get the hostIf storage medium interface attribute.
-1If Not able to get the hostIf storage medium interface attribute.
-2If Not handle the hostIf storage medium interface attribute.

Definition at line 384 of file Service_Storage_PhyMedium.cpp.

◆ get_Device_Service_StorageMedium_SerialNumber()

int hostIf_PhysicalMedium::get_Device_Service_StorageMedium_SerialNumber ( HOSTIF_MsgData_t *  stMsgData)

This function get the serial number of the storage service medium. Currently not implemented.

Parameters
[in]stMsgDataHostIf Message Request param contains the storage medium attribute value.
Returns
Returns an Integer value.
Return values
0If successfully get the hostIf storage medium interface attribute.
-1If Not able to get the hostIf storage medium interface attribute.
-2If Not handle the hostIf storage medium interface attribute.

Definition at line 402 of file Service_Storage_PhyMedium.cpp.

◆ get_Device_Service_StorageMedium_FirmwareVersion()

int hostIf_PhysicalMedium::get_Device_Service_StorageMedium_FirmwareVersion ( HOSTIF_MsgData_t *  stMsgData)

This function get the firmware version of the storage service medium. Currently not implemented.

Parameters
[in]stMsgDataHostIf Message Request param contains the storage medium attribute value.
Returns
Returns an Integer value.
Return values
0If successfully get the hostIf storage medium interface attribute.
-1If Not able to get the hostIf storage medium interface attribute.
-2If Not handle the hostIf storage medium interface attribute.

Definition at line 420 of file Service_Storage_PhyMedium.cpp.

◆ get_Device_Service_StorageMedium_ConnectionType()

int hostIf_PhysicalMedium::get_Device_Service_StorageMedium_ConnectionType ( HOSTIF_MsgData_t *  stMsgData)

This function get the connection type of the storage service medium. Currently not implemented.

Parameters
[in]stMsgDataHostIf Message Request param contains the storage medium attribute value.
Returns
Returns an Integer value.
Return values
0If successfully get the hostIf storage medium interface attribute.
-1If Not able to get the hostIf storage medium interface attribute.
-2If Not handle the hostIf storage medium interface attribute.

Definition at line 438 of file Service_Storage_PhyMedium.cpp.

◆ get_Device_Service_StorageMedium_Removable()

int hostIf_PhysicalMedium::get_Device_Service_StorageMedium_Removable ( HOSTIF_MsgData_t *  stMsgData)

This function get the storage service medium removable. Currently not implemented.

Parameters
[in]stMsgDataHostIf Message Request param contains the storage medium attribute value.
Returns
Returns an Integer value.
Return values
0If successfully get the hostIf storage medium interface attribute.
-1If Not able to get the hostIf storage medium interface attribute.
-2If Not handle the hostIf storage medium interface attribute.

Definition at line 456 of file Service_Storage_PhyMedium.cpp.

◆ get_Device_Service_StorageMedium_Status()

int hostIf_PhysicalMedium::get_Device_Service_StorageMedium_Status ( HOSTIF_MsgData_t *  stMsgData)

This function get the status of the storage service medium. Currently not implemented.

Parameters
[in]stMsgDataHostIf Message Request param contains the storage medium attribute value.
Returns
Returns an Integer value.
Return values
0If successfully get the hostIf storage medium interface attribute.
-1If Not able to get the hostIf storage medium interface attribute.
-2If Not handle the hostIf storage medium interface attribute.

Definition at line 474 of file Service_Storage_PhyMedium.cpp.

◆ get_Device_Service_StorageMedium_Uptime()

int hostIf_PhysicalMedium::get_Device_Service_StorageMedium_Uptime ( HOSTIF_MsgData_t *  stMsgData)

This function get the uptime of the storage service medium. Currently not implemented.

Parameters
[in]stMsgDataHostIf Message Request param contains the storage medium attribute value.
Returns
Returns an Integer value.
Return values
0If successfully get the hostIf storage medium interface attribute.
-1If Not able to get the hostIf storage medium interface attribute.
-2If Not handle the hostIf storage medium interface attribute.

Definition at line 492 of file Service_Storage_PhyMedium.cpp.

◆ get_Device_Service_StorageMedium_HotSwappable()

int hostIf_PhysicalMedium::get_Device_Service_StorageMedium_HotSwappable ( HOSTIF_MsgData_t *  stMsgData)

This function get the storage service medium hot swappable. Currently not implemented.

Parameters
[in]stMsgDataHostIf Message Request param contains the storage medium attribute value.
Returns
Returns an Integer value.
Return values
0If successfully get the hostIf storage medium interface attribute.
-1If Not able to get the hostIf storage medium interface attribute.
-2If Not handle the hostIf storage medium interface attribute.

Definition at line 510 of file Service_Storage_PhyMedium.cpp.