OpenTestSystem.Otx.Extensions.ComInterface.Terms.IsSecuredDoipSessionActive Class Reference

Checks the secured DoIP session mode of the related ComChannel is active or not More...

Inheritance diagram for OpenTestSystem.Otx.Extensions.ComInterface.Terms.IsSecuredDoipSessionActive:

Public Attributes
ComChannelTerm	comChannel
	Cardinality [1] Represents the handle of the communication channel on which the DoIP session mode should be retrieved. More...
ComInterfaceTerm	comInterface
	Cardinality [1] Represents the handle of the communication interface on which the DoIP session mode should be retrieved. More...
Public Attributes inherited from OpenTestSystem.Otx.Core.Terms.Term
MetaData	metaData
	Cardinality [0..1] The MetaData type allows tools to store additional, mainly tool-specific data. More...

Detailed Description

Checks the secured DoIP session mode of the related ComChannel is active or not

The IsSecuredDoipSessionActive term returns TRUE, if the secured DoIP session mode of the related ComChannel is active and FALSE, if no DoIP session or unsecured DoIP session is active.

An application may require to determine the mode of the currently established DoIP connection on the related ComChannel, e.g.insecure DoIP session or secured DoIP session(with TLS).

Note: The appropriate MVCI system operation is MCDLogicalLink::execIOCtrl(DOIP_GET_CURRENT_SESSION_MODE).

Exceptions

Exceptions.TLSException

If getting the DoIP session mode failed. In the case of an MVCI System, this happens if the return value of the related IOCtrl is one of the following values: PDU_ERR_PDUAPI_NOT_CONSTRUCTED D-PDU API has not been constructed before PDU_ERR_COMM_PC_TO_VCI_FAILED Communication between host and MVCI protocol module failed PDU_ERR_INVALID_HANDLE Invalid MVCI protocol module Handle or ComLogicalLink handle PDU_ERR_MODULE_NOT_CONNECTED MVCI protocol module has not been connected PDU_ERR_FCT_FAILED Function call failed

Syntax

BooleanTerm = ComInterface.IsSecuredDoipSessionActive(ComInterfaceTerm comInterface, ComChannelTerm comChannel);

Member Data Documentation

comChannel

ComChannelTerm OpenTestSystem.Otx.Extensions.ComInterface.Terms.IsSecuredDoipSessionActive.comChannel

Cardinality [1]
Represents the handle of the communication channel on which the DoIP session mode should be retrieved.

comInterface

ComInterfaceTerm OpenTestSystem.Otx.Extensions.ComInterface.Terms.IsSecuredDoipSessionActive.comInterface

Cardinality [1]
Represents the handle of the communication interface on which the DoIP session mode should be retrieved.