InterfaceStack Client RequestHandler Public Classes

Description

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

Data Structures
class	InterfaceStackClientReqHandler
	This class provides the interface for getting InterfaceStack client request handler information. More...

Functions
virtual bool	InterfaceStackClientReqHandler::init ()
	This function is used to initialize. Currently not implemented. More...
virtual bool	InterfaceStackClientReqHandler::unInit ()
	This function is used to close all the instances of interface stack. More...
virtual int	InterfaceStackClientReqHandler::handleSetMsg (HOSTIF_MsgData_t *stMsgData)
	This function is used to handle the set message request of InterfaceStack Client. Currently not implemented. More...
virtual int	InterfaceStackClientReqHandler::handleGetMsg (HOSTIF_MsgData_t *stMsgData)
	This function is used to handle the get message request of InterfaceStack Client. Gets the total number of active interface stack entries or get the attributes of interface stack such as "HigherLayer" and "LowerLayer". More...

---

Data Structure Documentation

InterfaceStackClientReqHandler

class InterfaceStackClientReqHandler

This class provides the interface for getting InterfaceStack client request handler information.

Interface Stack Client interface is a platform agnostic IARM communication interface. It allows Interface stack client applications to communicate by sending Get and Set operation

Definition at line 59 of file hostIf_InterfaceStackClient_ReqHandler.h.

Inheritance diagram for InterfaceStackClientReqHandler:

Collaboration diagram for InterfaceStackClientReqHandler:

Public Member Functions
virtual bool	init ()
	This function is used to initialize. Currently not implemented. More...
virtual bool	unInit ()
	This function is used to close all the instances of interface stack. More...
virtual int	handleSetMsg (HOSTIF_MsgData_t *stMsgData)
	This function is used to handle the set message request of InterfaceStack Client. Currently not implemented. More...
virtual int	handleGetMsg (HOSTIF_MsgData_t *stMsgData)
	This function is used to handle the get message request of InterfaceStack Client. Gets the total number of active interface stack entries or get the attributes of interface stack such as "HigherLayer" and "LowerLayer". More...
virtual int	handleGetAttributesMsg (HOSTIF_MsgData_t *stMsgData)
virtual int	handleSetAttributesMsg (HOSTIF_MsgData_t *stMsgData)
Static Public Member Functions
static msgHandler *	getInstance ()
static void	registerUpdateCallback (updateCallback cb)
static void	checkForUpdates ()
static void	reset ()
Static Private Attributes
static class InterfaceStackClientReqHandler *	pInstance = NULL
static updateCallback	mUpdateCallback = NULL
static int	curNumOfEntriesInInterfaceStack = 0

Function Documentation

init()

bool InterfaceStackClientReqHandler::init ( )

virtual

This function is used to initialize. Currently not implemented.

Returns

Returns the status of the operation.

Return values

true	if initialization is successful.
false	if initialization is not successful.

Implements msgHandler.

Definition at line 66 of file hostIf_InterfaceStackClient_ReqHandler.cpp.

unInit()

bool InterfaceStackClientReqHandler::unInit ( )

virtual

This function is used to close all the instances of interface stack.

Returns

Returns the status of the operation.

Return values

true	if it successfully close all the instances.
false	if not able to close all the instances.

Implements msgHandler.

Definition at line 80 of file hostIf_InterfaceStackClient_ReqHandler.cpp.

handleSetMsg()

int InterfaceStackClientReqHandler::handleSetMsg ( HOSTIF_MsgData_t *  stMsgData )

virtual

This function is used to handle the set message request of InterfaceStack Client. Currently not implemented.

Parameters

[out]

stMsgData

TR-069 Host interface message request.

Returns

Returns the status of the operation.

Return values

OK	if successful.
ERR_INTERNAL_ERROR	if not able to set the data to the device.

Implements msgHandler.

Definition at line 101 of file hostIf_InterfaceStackClient_ReqHandler.cpp.

handleGetMsg()

int InterfaceStackClientReqHandler::handleGetMsg ( HOSTIF_MsgData_t *  stMsgData )

virtual

This function is used to handle the get message request of InterfaceStack Client. Gets the total number of active interface stack entries or get the attributes of interface stack such as "HigherLayer" and "LowerLayer".

Parameters

[out]

stMsgData

TR-069 Host interface message request.

Returns

Returns the status of the operation.

Return values

OK	if successful.
ERR_INTERNAL_ERROR	if not able to set the data to the device.

Implements msgHandler.

Definition at line 124 of file hostIf_InterfaceStackClient_ReqHandler.cpp.