RDK Documentation (Open Sourced RDK Components)
TimeClient RequestHandler Public Classes

Description

Describe the details about classes used in TR-069 time client request handler.

Data Structures

class  TimeClientReqHandler
 This class provides the interface for getting TimeClient request handler information. More...
 

Functions

virtual bool TimeClientReqHandler::init ()
 This function is use to initialize. Currently not implemented. More...
 
virtual bool TimeClientReqHandler::unInit ()
 This function is used to close all the instances of time client. More...
 
virtual int TimeClientReqHandler::handleSetMsg (HOSTIF_MsgData_t *stMsgData)
 This function is use to handle the set message request of time client interface and set the attributes of the time client component. More...
 
virtual int TimeClientReqHandler::handleGetMsg (HOSTIF_MsgData_t *stMsgData)
 This function use to handle the get message request of time client interface and get the attributes of the time client component "LocalTimeZone" and "CurrentLocalTime". More...
 

Data Structure Documentation

◆ TimeClientReqHandler

class TimeClientReqHandler

This class provides the interface for getting TimeClient request handler information.

Definition at line 55 of file hostIf_TimeClient_ReqHandler.h.

Inheritance diagram for TimeClientReqHandler:
Inheritance graph
Collaboration diagram for TimeClientReqHandler:
Collaboration graph

Public Member Functions

virtual bool init ()
 This function is use to initialize. Currently not implemented. More...
 
virtual bool unInit ()
 This function is used to close all the instances of time client. More...
 
virtual int handleSetMsg (HOSTIF_MsgData_t *stMsgData)
 This function is use to handle the set message request of time client interface and set the attributes of the time client component. More...
 
virtual int handleGetMsg (HOSTIF_MsgData_t *stMsgData)
 This function use to handle the get message request of time client interface and get the attributes of the time client component "LocalTimeZone" and "CurrentLocalTime". More...
 
virtual int handleGetAttributesMsg (HOSTIF_MsgData_t *stMsgData)
 
virtual int handleSetAttributesMsg (HOSTIF_MsgData_t *stMsgData)
 

Static Public Member Functions

static msgHandlergetInstance ()
 
static void registerUpdateCallback (updateCallback cb)
 
static void checkForUpdates ()
 

Static Private Attributes

static class TimeClientReqHandlerpInstance = NULL
 
static updateCallback mUpdateCallback = NULL
 

Function Documentation

◆ init()

bool TimeClientReqHandler::init ( )
virtual

This function is use to initialize. Currently not implemented.

Returns
Returns the status of the operation.
Return values
trueif initialization is successfully .
falseif initialization is not successful.

Implements msgHandler.

Definition at line 59 of file hostIf_TimeClient_ReqHandler.cpp.

◆ unInit()

bool TimeClientReqHandler::unInit ( )
virtual

This function is used to close all the instances of time client.

Returns
Returns the status of the operation.
Return values
trueif it is successfully close all the instances.
falseif not able to close all the instances.

Implements msgHandler.

Definition at line 75 of file hostIf_TimeClient_ReqHandler.cpp.

◆ handleSetMsg()

int TimeClientReqHandler::handleSetMsg ( HOSTIF_MsgData_t stMsgData)
virtual

This function is use to handle the set message request of time client interface and set the attributes of the time client component.

Parameters
[out]stMsgDataTR-069 Host interface message request.
Returns
Returns the status of the operation.
Return values
OKif it is successfully.
ERR_INTERNAL_ERRORif not able to set the data to the device.

Implements msgHandler.

Definition at line 97 of file hostIf_TimeClient_ReqHandler.cpp.

◆ handleGetMsg()

int TimeClientReqHandler::handleGetMsg ( HOSTIF_MsgData_t stMsgData)
virtual

This function use to handle the get message request of time client interface and get the attributes of the time client component "LocalTimeZone" and "CurrentLocalTime".

Parameters
[out]stMsgDataTR-069 Host interface message request.
Returns
Returns the status of the operation.
Return values
OKif it is successfully.
ERR_INTERNAL_ERRORif not able to get data from the device.

Implements msgHandler.

Definition at line 154 of file hostIf_TimeClient_ReqHandler.cpp.