TR-069 Object (Device.IP.ActivePort.Interface.{i}) Public APIs

Description

Describe the details about TR-069 Device IP active port APIs specifications.

Functions
int	hostIf_IPActivePort::get_Device_IP_ActivePort_LocalIPAddress (HOSTIF_MsgData_t *, bool *pChanged=NULL)
	This function gets the local IP Address of the connection. More...
int	hostIf_IPActivePort::get_Device_IP_ActivePort_LocalPort (HOSTIF_MsgData_t *, bool *pChanged=NULL)
	This function gets the local port number of the connection. More...
int	hostIf_IPActivePort::get_Device_IP_ActivePort_RemoteIPAddress (HOSTIF_MsgData_t *, bool *pChanged=NULL)
	This function gets the remote IP Address of the established connection. It provides the remote IP address of the source of inbound packets. More...
int	hostIf_IPActivePort::get_Device_IP_ActivePort_RemotePort (HOSTIF_MsgData_t *, bool *pChanged=NULL)
	This function gets the remote port number of the established connection. It provides the remote port number of the source of inbound packets. More...
int	hostIf_IPActivePort::get_Device_IP_ActivePort_Status (HOSTIF_MsgData_t *, bool *pChanged=NULL)
	This function gets the current operational status of the connection. The possible values are 'LISTEN', 'ESTABLISHED'. More...

Function Documentation

get_Device_IP_ActivePort_LocalIPAddress()

int hostIf_IPActivePort::get_Device_IP_ActivePort_LocalIPAddress	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = NULL
	)

This function gets the local IP Address of the connection.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns

Returns the status of the operation.

Return values

OK	if is successfully fetch the data from the device.
ERR_INTERNAL_ERROR	if not able to fetch the data.

Definition at line 266 of file Device_IP_ActivePort.cpp.

get_Device_IP_ActivePort_LocalPort()

int hostIf_IPActivePort::get_Device_IP_ActivePort_LocalPort	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = NULL
	)

This function gets the local port number of the connection.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns

Returns the status of the operation.

Return values

OK	if is successfully fetch the data from the device.
ERR_INTERNAL_ERROR	if not able to fetch the data.

Definition at line 298 of file Device_IP_ActivePort.cpp.

get_Device_IP_ActivePort_RemoteIPAddress()

int hostIf_IPActivePort::get_Device_IP_ActivePort_RemoteIPAddress	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = NULL
	)

This function gets the remote IP Address of the established connection. It provides the remote IP address of the source of inbound packets.

Note

This will be an empty string for listening connections ESTABLISHED state have remote addresses.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns

Returns the status of the operation.

Return values

OK	if is successfully fetch the data from the device.
ERR_INTERNAL_ERROR	if not able to fetch the data.

Definition at line 332 of file Device_IP_ActivePort.cpp.

get_Device_IP_ActivePort_RemotePort()

int hostIf_IPActivePort::get_Device_IP_ActivePort_RemotePort	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = NULL
	)

This function gets the remote port number of the established connection. It provides the remote port number of the source of inbound packets.

Note

This will be 0 for listening connections only ESTABLISHED the state have remote addresses.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns

Returns the status of the operation.

Return values

OK	if is successfully fetch the data from the device.
ERR_INTERNAL_ERROR	if not able to fetch the data.

Definition at line 365 of file Device_IP_ActivePort.cpp.

get_Device_IP_ActivePort_Status()

int hostIf_IPActivePort::get_Device_IP_ActivePort_Status	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = NULL
	)

This function gets the current operational status of the connection. The possible values are 'LISTEN', 'ESTABLISHED'.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns

Returns the status of the operation.

Return values

OK	if is successfully fetch the data from the device.
ERR_INTERNAL_ERROR	if not able to fetch the data.

Definition at line 395 of file Device_IP_ActivePort.cpp.