ndDoIPEntityStatus

Purpose

Gets status information from a DoIP entity.

Format

long ndDoIPEntityStatus(
       TD1 *diagRef,
       unsigned char *nodeType,
       unsigned char *maxSockets,
       unsigned char *curSockets,
       LVBoolean *ok);

Input

diagRef

Specifies the handle for the diagnostic session, obtained from ndOpenDiagnosticOnIPStack and passed to subsequent diagnostic functions. Normally, it is not necessary to manually manipulate the elements of this struct. Output

nodeType

Indicates the type of DoIP entity. Possible values are:

All other values are reserved.

maxSockets

Represents the maximum number of concurrent TCP/IP sockets allowed with this DoIP entity, excluding the reserve socket required for socket handling.

curSockets

The number of currently established TCP/IP sockets.

ok

Indicates successful receipt of a positive response message for this diagnostic service.

Return Value

The return value indicates the function call status as a signed 32-bit integer. Zero means the function executed successfully. A negative value specifies an error, which means the function did not perform the expected behavior. A positive value specifies a warning, which means the function performed as expected, but a condition arose that may require attention.

Use the ndStatusToString function to obtain a descriptive string for the return value.

ndDoIPEntityStatus serves the purpose of identifying certain operating conditions of the responding DoIP entity. For example, this allows for test equipment to detect existing diagnostic communication sessions as well as a DoIP entity's capabilities.