TCPIP_Helper_TCPSecurePortGet Function

C

bool TCPIP_Helper_TCPSecurePortGet(
    uint16_t tcpPort
);

Description

This function checks the internal data for detecting if the required TCP port is a secure port or not. A secure port is one that requires secure connections. The TCP/IP stack maintains an internal table with the ports that require secure connections. This table can be maintained using the TCPIP_Helper_SecurePortSe() function.

Preconditions

TCP/IP stack properly initialized.

Parameters

ParametersDescription
tcpPortThe TCP port to query.

Returns

  • True - If the port is a secure connection port.

  • False - If port is not secure (the port is not found in the internal secure ports table).

Remarks

The TCP/IP stack populates the internal secure port table with default values as part of the stack power up procedure. The table is not re-initialized when the stack is brought down and then restarted.