Socket Adaptor (SoAd)

Allows to read and reset detailed measurement data for diagnostic purposes. Get all MeasurementIdx's at once is not supported. SOAD_MEAS_ALL shall only be used to reset all MeasurementIdx's at once. A NULL_PTR shall be provided for MeasurementDataPtr in this case.

Requests transmission of a PDU.

Initializes the Socket Adaptor.

Returns the version information.

The TCP/IP stack calls this primitive after the reception of data on a socket. The socket identifier along with configuration information determines which module is to be called.

The TCP/IP stack calls this function after the data has been acknowledged by the peer for TCP. Caveats: The upper layer might not be able to determine exactly which data bytes have been confirmed.

This service gets called if the stack put a socket into the listen mode before (as server) and a peer connected to it (as client). In detail: The TCP/IP stack calls this function after a socket was set into the listen state with TcpIp_TcpListen() and a TCP connection is requested by the peer.

This service gets called if the stack initiated a TCP connection before (as client) and the peer (the server) acknowledged the connection set up. In detail: The TCP/IP stack calls this function after a socket was requested to connect with TcpIp_TcpConnect() and a TCP connection is confirmed by the peer. The parameter value of SocketId equals the SocketId value of the preceeding TcpIp_TcpConnect() call.

Requests transmission of a PDU.

Indication of a received PDU from a lower layer communication interface module.

The lower layer communication interface module confirms the transmission of a PDU, or the failure to transmit a PDU.

Schedules the Socket Adaptor. (Entry point for scheduling)

This function is called to acquire the transmit data of an I-PDU segment (N-PDU). Each call to this function provides the next part of the I-PDU data unless retry->TpDataState is TP_ DATARETRY. In this case the function restarts to copy the data beginning at the offset from the current position indicated by retry->TxTpDataCnt. The size of the remaining data is written to the position indicated by availableDataPtr.

This function is called at the start of receiving an N-SDU. The N-SDU might be fragmented into multiple N-PDUs (FF with one or more following CFs) or might consist of a single N-PDU (SF). The service shall provide the currently available maximum buffer size when invoked with TpSdu Length equal to 0.

This function is called to provide the received data of an I-PDU segment (N-PDU) to the upper layer. Each call to this function provides the next part of the I-PDU data. The size of the remaining buffer is written to the position indicated by bufferSizePtr.

of the event just encountered. Parameters (inout) None Parameters (out) None Return value None Description This service gets called if the stack encounters a condition described by the values in Event.

Called after an I-PDU has been received via the TP API, the result indicates whether the transmission was successful or not.

This function is called after the I-PDU has been transmitted on its network, the result indicates whether the transmission was successful or not.

This service gets called by the TCP/IP stack if an IP address assignment changes (i.e. new address assigned or assigned address becomes invalid).

Retrieves the local address (IP address and port) actually used for the SoAd socket connection specified by SoConId, the netmask and default router

Retrieves the physical source address of the EthIf controller used by the SoAd socket connection specified by SoConId.

Request to change a specific transport protocol parameter (e.g. block size).

Returns socket connection index related to the specified TxPduId.

This service opens the socket connection specified by SoConId.

This service closes the socket connection specified by SoConId.

This function gets called by the SoAd if an IP address assignment related to a socket connection changes (i.e. new address assigned or assigned address becomes invalid).

Notification about a SoAd socket connection state change, e.g. socket connection gets online

By this API service the remote address (IP address and port) of the specified socket connection shall be set.

Enables routing of a group of PDUs in the SoAd related to the RoutingGroup specified by parameter id. Routing of PDUs can be either forwarding of PDUs from the upper layer to a TCP or UDP socket of the TCP/IP stack specified by a PduRoute or the other way around specified by a SocketRoute.

Disables routing of a group of PDUs in the SoAd related to the RoutingGroup specified by parameter id. Routing of PDUs can be either forwarding of PDUs from the upper layer to a TCP or UDP socket of the TCP/IP stack specified by a PduRoute or the other way around specified by a SocketRoute.

By this API service the local IP address assignment which shall be used for the socket connection specified by SoConId is initiated.

Requests cancellation of an ongoing reception of a PDU in a lower layer transport protocol module.

Requests cancellation of an ongoing transmission of a PDU in a lower layer communication module.

This service requests to copy data for transmission to the buffer indicated. This call is triggered by TcpIp_Transmit(). Note: The call to <Up>_CopyTxData() may happen in the context of Tcp Ip_Transmit().

By this API service the local IP address assignment used for the socket connection specified by SoConId is released.

Retrieves the remote address (IP address and port) actually used for the SoAd socket connection specified by SoConId

Triggers the transmission of all If-TxPDUs identified by the parameter id after requesting the data from the related upper layer.

Within this API, the upper layer module (called module) shall check whether the available data fits into the buffer size reported by PduInfoPtr->SduLength. If it fits, it shall copy its data into the buffer provided by PduInfoPtr->SduDataPtr and update the length of the actual copied data in PduInfoPtr->SduLength. If not, it returns E_NOT_OK without changing PduInfoPtr.

This API service shall either return the socket connection index of the SoAdSocketConnection Group where the specified remote address (IP address and port) is set or assign the remote address to an unused socket connection from the same SoAdSocketConnectionGroup.

By this API service an upper layer of the SoAd can set the hostname, i.e. FQDN option in the DHCP submodule of the TCP/IP stack.

By this API service an upper layer of the SoAd can read the currently configured hostname, i.e. FQDN option in the DHCP submodule of the TCP/IP stack.

Triggers the transmission of all If-TxPDUs identified by the parameter id on the socket connection specified by SoConId after requesting the data from the related upper layer.

Enables routing of a group of PDUs in the SoAd related to the RoutingGroup specified by parameter id only on the socket connection identified by SoConId.

Disables routing of a group of PDUs in the SoAd related to the RoutingGroup specified by parameter id only on the socket connection identified by SoConId.

By this API service the remote address (IP address and port) of the specified socket connection shall be released, i.e. set back to the configured remote address setting.

Returns current state of the socket connection specified by SoConId.

API allows to check if a communication over this socket connection is possible for a dedicated remote address. It includes that the socket connection is bound to a socket, a physical address is available for the requested remote address and if a security association is configured that a secured connection is already established.

Configuration data structure of the SoAd module.

type to specify the state of a SoAd socket connection.

SoCon identifier type for unique identification of a SoAd socket connection. The size of this type depends on the maximum number of socket connections which is specified by configuration parameter SoAdSoConMax.

RoutingGroup identifier type for unique identification of a SoAd routing group. The size of this type depends on the maximum number of routing groups which is specified by configuration parameter SoAdRoutingGroupMax.

Index to select specific measurement data

All configuration items shall be located outside the kernel of the module.

Type of error Related error code Error value API service called before initializing the module SOAD_E_UNINIT 0x01 API service called with NULL pointer SOAD_E_PARAM_POINTER 0x02 Invalid argument SOAD_E_INV_ARG 0x03 Invalid PDU ID SOAD_E_INV_PDUID 0x06 Invalid socket address SOAD_E_INV_SOCKETID 0x07 Invalid configuration set selection SOAD_E_INIT_FAILED 0x08 Type of error Related error code Error value Invalid meta data SOAD_E_INV_METADATA 0x09

The main function for scheduling the SoAd (Entry point for scheduling) shall be called by the Schedule Manager according to the configured call period.

The call period of the SoAd_MainFunction () shall be deter- mined by configuration parameter SoAdMainFunctionPeriod .

In case PDU header option is enabled ( SoAdPduHeaderEn- able is TRUE ) for a socket connection and PDU transmission, SoAd shall insert the PDU Header with the configured HeaderId and the actual PDU length directly before the PDU data, i.e. TcpIp_UdpTransmit () or TcpIp_TcpTransmit () shall be called with a TotalLength or AvailableLength increased by the PDU Header length, the PDU Header shall be copied before the PDU data to a SoAd UDP transmit buffer (if any) and a memory specified by TcpIp within SoAd_CopyTxData () requesting the be- gin of the PDU data.

The SoAd PDU header shall consist of a 4 byte ID field for unique identification of the PDU at the receiver and a 4 byte length field specifying the data length of the PDU. Both in BigEndian byte order.

All timing parameters given as EcucFloatParamDef in unit sec- onds in the configuration, shall be converted to integer multiples of the parameter SoAdMainFunctionPeriod .

SoAd_Init () shall store the access to the configuration struc- ture for subsequent API calls.

If development error detection is enabled: SoAd_IfTrans- mit () shall check that the service SoAd_Init () was previously called. If the check fails, SoAd_IfTransmit () shall raise the development error SOAD_E_UNINIT .

If development error detection is enabled: SoAd_IfTrans- mit () shall check parameter TxPduId for being valid. If the check fails, SoAd_If- Transmit () shall raise the development error SOAD_E_INV_PDUID .

If development error detection is enabled: SoAd_Init () shall check the parameter SoAdConfigPtr for containing a valid configuration. If the check fails, SoAd_Init () shall raise the development error SOAD_E_INIT_FAILED .

If development error detection is enabled: SoAd_TpTrans- mit () shall check that the service SoAd_Init () was previously called. If the check fails, SoAd_TpTransmit () shall raise the development error SOAD_E_UNINIT .

If development error detection is enabled: SoAd_TpTrans- mit () shall check parameter TxPduId for being valid. If the check fails, SoAd_Tp- Transmit () shall raise the development error SOAD_E_INV_PDUID .

If development error detection is enabled: SoAd_RxIndica- tion () shall check that the service SoAd_Init () was previously called. If the check fails, SoAd_RxIndication () shall raise the development error SOAD_E_UNINIT .

If development error detection is enabled: SoAd_RxIndica- tion () shall check parameter SocketId for being valid. If the check fails, SoAd_- RxIndication () shall raise the development error SOAD_E_INV_SOCKETID .

If development error detection is enabled: SoAd_RxIndica- tion () shall check parameter RemoteAddrPtr for being valid. If the check fails, SoAd_RxIndication () shall raise the development error SOAD_E_INV_ARG .

If development error detection is enabled: SoAd_TxConfir- mation () shall check that the service SoAd_Init () was previously called. If the check fails, SoAd_TxConfirmation () shall raise the development error SOAD_E_UNINIT .

If development error detection is enabled: SoAd_TxConfir- mation () shall check parameter SocketId for being valid. If the check fails, SoAd_- TxConfirmation () shall raise the development error SOAD_E_INV_SOCKETID .

If development error detection is enabled: SoAd_TxConfir- mation () shall check parameter Length for being valid. If the check fails, SoAd_Tx- Confirmation () shall raise the development error SOAD_E_INV_ARG .

If development error detection is enabled: SoAd_TcpAc- cepted () shall check that the service SoAd_Init () was previously called. If the check fails, SoAd_TcpAccepted () shall raise the development error SOAD_E_UNINIT .

If development error detection is enabled: SoAd_TcpAc- cepted () shall check parameter SocketId for being valid. If the check fails, SoAd_- TcpAccepted () shall raise the development error SOAD_E_INV_SOCKETID .

If development error detection is enabled: SoAd_TcpCon- nected () shall check that the service SoAd_Init () was previously called. If the check fails, SoAd_TcpConnected () shall raise the development error SOAD_E_UNINIT .

If development error detection is enabled: SoAd_TcpCon- nected () shall check parameter SocketId for being valid. If the check fails, SoAd_- TcpConnected () shall raise the development error SOAD_E_INV_SOCKETID .

If development error detection is enabled: SoAd_- TcpIpEvent () shall check that the service SoAd_Init () was previously called. If the check fails, SoAd_TcpIpEvent () shall raise the development error SOAD_E_UNINIT .

If development error detection is enabled: SoAd_- TcpIpEvent () shall check parameter SocketId for being valid. If the check fails, SoAd_TcpIpEvent () shall raise the development error SOAD_E_INV_SOCKETID .

If development error detection is enabled: SoAd_- TcpIpEvent () shall check parameter Event for being valid. If the check fails, SoAd_- TcpIpEvent () shall raise the development error SOAD_E_INV_ARG .

If development error detection is enabled: SoAd_LocalIpAd- drAssignmentChg () shall check that the service SoAd_Init () was previously called. If the check fails, SoAd_LocalIpAddrAssignmentChg () shall raise the development error SOAD_E_UNINIT .

These requirements are not applicable to this specifica- tion.

Module Header File Imported Type ComStack_Types.h BufReq_ReturnType ComStack_Types.h PduIdType ComStack_Types.h PduInfoType ComStack_Types.h PduLengthType ComStack_Types.h RetryInfoType ComStack_Types.h TPParameterType ComStack_Types ComStack_Types.h TpDataStateType IdsM IdsM_Types.h IdsM_SecurityEventIdType Std_Types.h Std_ReturnType Std Std_Types.h Std_VersionInfoType TcpIp.h TcpIp_DomainType TcpIp.h TcpIp_EventType TcpIp.h TcpIp_IpAddrAssignmentType TcpIp.h TcpIp_IpAddrStateType TcpIp.h TcpIp_LocalAddrIdType TcpIp.h TcpIp_ParamIdType TcpIp.h TcpIp_ProtocolType TcpIp.h TcpIp_ReturnType TcpIp.h TcpIp_SockAddrType TcpIp.h TcpIp_SocketIdType TcpIp TcpIp.h TcpIp_StateType

Det_ReportRuntimeError Det.h Service to report runtime errors. If a callout has been configured then this callout shall be called. TcpIp_<Up>GetSocket TcpIp.h By this API service the TCP/IP stack is requested to allocate a new socket. Note: Each accepted incoming TCP connection also allocates a socket resource. TcpIp_Bind TcpIp.h By this API service the TCP/IP stack is requested to bind a UDP or TCP socket to a local resource. TcpIp_ChangeParameter TcpIp.h By this API service the TCP/IP stack is requested to change a parameter of a socket. E.g. the Nagle algorithm may be controlled by this API. TcpIp_Close TcpIp.h By this API service the TCP/IP stack is requested to close the socket and release all related resources. TcpIp_GetCtrlIdx TcpIp.h TcpIp_GetCtrlIdx returns the index of the controller related to LocalAddrId. TcpIp_GetIpAddr TcpIp.h Obtains the local IP address actually used by Local AddrId, the netmask and default router API Function Header File Description TcpIp_GetPhysAddr TcpIp.h Obtains the physical source address used by the EthIf controller implicitly specified via LocalAddrId. TcpIp_GetRemotePhysAddr TcpIp.h TcpIp_GetRemotePhysAddr queries the IP/physical address translation table specified by CtrlIdx and returns the physical address related to the IP address specified by IpAddrPtr. In case no physical address can be retrieved and parameter initRes is TRUE, address resolution for the specified IP address is initiated on the local network. TcpIp_ReleaseIpAddrAssignment TcpIp.h By this API service the local IP address assignment for the IP address specified by LocalAddrId shall be released. TcpIp_RequestComMode TcpIp.h By this API service the TCP/IP stack is requested to change the TcpIp state of the communication network identified by EthIf controller index. TcpIp_RequestIpAddrAssignment TcpIp.h By this API service the local IP address assignment for the IP address specified by LocalAddrId shall be initiated. TcpIp_TcpConnect TcpIp.h By this API service the TCP/IP stack is requested to establish a TCP connection to the configured peer. TcpIp_TcpListen TcpIp.h By this API service the TCP/IP stack is requested to listen on the TCP socket specified by the socket identifier. TcpIp_TcpReceived TcpIp.h By this API service the reception of socket data is confirmed to the TCP/IP stack. TcpIp_TcpTransmit TcpIp.h This service requests transmission of data via TCP to a remote node. The transmission of the data is decoupled. Note: The TCP segment(s) are sent dependent on runtime factors (e.g. receive window) and configuration parameter (e.g. Nagle algorithm) . TcpIp_UdpTransmit TcpIp.h This service transmits data via UDP to a remote node. The transmission of the data is immediately performed with this function call by forwarding it to EthIf.

The SoAd shall provide sufficient buffers to store received data which can't be forwarded to the upper layer within the context of SoAd_RxIndica- tion () as well as buffers for data which can (or should) not be forwarded to TcpIp.

If SoAdSocketMsgAcceptanceFilterEnabled is TRUE , SoAd shall only accept TCP connections or UDP datagrams from remote nodes with a source address that matches the remote address specified in the socket connec- tion (either via configuration parameters SoAdSocketRemoteIpAddress and SoAd- SocketRemotePort or set online with SoAd_SetRemoteAddr () API).

A remote address matches if both IP address and port match. The IP addresses match if they are identical or if the specified IP address is set to TCPIP_IPADDR_ANY ( TCPIP_IP6ADDR_ANY ). The port matches if they are identical or if the specified port is set to TCPIP_PORT_ANY .

SoAd shall reset the remote address to the configured remote address (or unset the remote address in case no remote address has been configured) within SoAd_MainFunction () when a socket connection is closed.

If development error detection is enabled: In case SoAd_OpenSoCon () is called for a socket connection with configuration param- eter SoAdSocketAutomaticSoConSetup set to " TRUE " the development error SOAD_E_INV_ARG shall be raised.

If development error detection is enabled: In case SoAd_Clos- eSoCon () is called for a socket connection with configuration parameter SoAdSock- etAutomaticSoConSetup set to " TRUE " the development error SOAD_E_INV_ARG shall be raised.

If development error detection is enabled and SoConId refers to a socket connection with configuration parameter SoAdSocketAutomaticSoCon- Setup set to TRUE , the function SoAd_SetRemoteAddr () shall raise the development error SOAD_E_INV_ARG .

The function SoAd_SetRemoteAddr () shall only proceed if SoConId refers to a socket connection which is not currently locked by the SoAd. If it is locked, the request shall be rejected and E_NOT_OK shall be returned.

The function SoAd_SetRemoteAddr () shall set the remote ad- dress of the socket connection referred by parameter SoConId according to the IP address and port specified by parameter RemoteAddrPtr.

For each configurable interface SoAd shall determine the func- tion name by replacing the tag <Up> with the module name abbreviation of the related upper layer module (as specified in the SoAdBSWModules container using the SoAd- BswModuleRef reference parameter) and using the two infix according to the configu- ration parameters SoAdUseCallerInfix and SoAdUseTypeInfix.

For the transmission of a PDU requested by an upper layer using the IF-API, the SoAd shall 1. Identify the related socket connection and PDU route by using the TxPduId pro- vided at SoAd_IfTransmit (). 2. Call the related TcpIp transmit function depending on the connection type if the PDU length > 0 or SoAdPduHeaderEnable is TRUE , otherwise SoAd shall Skip further processing and return with E_NOT_OK .

In case of a UDP socket connection the SoAd shall (if not speci- fied otherwise) call TcpIp_UdpTransmit () with SocketId and remote address spec- ified in the SocketConnection and the PDU length specified in the SoAd_IfTrans- mit () call as TotalLength .

In case of a TCP socket connection the SoAd shall call TcpIp_TcpTransmit () with SocketId specified in the SocketConnection, the PDU length specified in the SoAd_IfTransmit () call, as AvailableLength and ForceRetrieve set to TRUE .

The TcpIp module will retrieve the PDU data within the context of the TcpIp transmit call by using SoAd_CopyTxData () where the SoAd shall copy (the requested part of) the PDU to the memory specified by parameter BufPtr .

In case of a UDP socket connection the SoAd shall call the upper layer with the configured transmit confirmation function ( <Up>[SoAd][If]Tx- Confirmation ()) with result set to E_OK within the next SoAd_MainFunction () after the latest TcpIp_UdpTransmit () call returning successfully.

In case of a TCP socket connection the SoAd shall call the upper layer with the configured transmit confirmation function ( <Up>[SoAd][If]Tx- Confirmation ()) with result set to E_OK within the SoAd_TxConfirmation () call- back function after all PDU data (from one or multiple transmit requests) have been confirmed for transmission.

In case SoAdTxUdpTriggerMode is set to TRIGGER_NEVER for any PDU route ( SoAdPduRouteDest ) related to a socket connection and all upper layers belonging to the related socket connection have SoAdTxUpperLayerType set to "IF", SoAd shall use the nPdu feature for this socket connection.

In case the nPdu feature is used for a socket connection and SoAdTxUdpTriggerMode is set to TRIGGER_NEVER for the actual PDU ( SoAdP- duRouteDest ), SoAd shall store the PDU for the socket connection (instead of calling TcpIp_UdpTransmit ()).

In case the nPdu feature is used for a socket connection and SoAdTxUdpTriggerMode is set to TRIGGER_ALWAYS for the current PDU ( SoAdP- duRouteDest ) and the resulting PDU data and headers don't exceed SoAdSocket- nPduUdpTxBufferMin , SoAd shall transmit all PDUs stored for the socket connection (if any) and the current PDU by calling TcpIp_UdpTransmit ().

In case the nPdu feature is used for a socket connection and SoAdTxUdpTriggerMode is set to TRIGGER_NEVER for the current PDU ( SoAdP- duRouteDest ) and the resulting PDU data and headers would exceed SoAdSocket- nPduUdpTxBufferMin , SoAd shall first transmit all PDUs stored for the socket con- nection by calling TcpIp_UdpTransmit () and then store the PDU for the socket con- nection.

Within SoAd_MainFunction () SoAd shall transmit all PDUs stored for a socket connection (if any) by calling TcpIp_UdpTransmit () if the nPdu specific timer expired.

For the transmission of a PDU requested by an upper layer using the TP-API, the SoAd shall 1. Skip further processing and return with E_NOT_OK if the PDU length is 0. 2. Identify the related socket connection and PDU route by using the TxPduId pro- vided at SoAd_TpTransmit (). 3. Store the TP transmission request for further processing in the SoAd_Main- Function ().

In the SoAd_MainFunction () the SoAd shall check for pend- ing TP transmission requests and process a pending request as specified below: 1. Query the available amount of data at the upper layer by calling the configurable callback function <Up>_[SoAd][Tp]CopyTxData () with PduInfoType.Sdu- Length = 0. 2. Depending on the connection type: retrieve data and call the related TcpIp trans- mit function.

In case of a UDP socket connection the SoAd shall 1. retrieve all available data from the upper layer to a SoAd TP transmit buffer via the configurable callback function <Up>_[SoAd][Tp]CopyTxData () with PduIn- foType.SduLength set to the value returned by availableDataPtr of the previ- ous call and 2. call TcpIp_UdpTransmit () with SocketId and remote address specified in the SocketConnection and the PDU length specified in the SoAd_TpTransmit () call as TotalLength after all data have been successfully retrieved within one or multiple SoAd main function execution cycles.

In case of a TCP socket connection the SoAd shall call TcpIp_TcpTransmit () with SocketId specified in the SocketConnection, the PDU length set to the value returned by availableDataPtr of the previous call to <Up>_- [SoAd][Tp]CopyTxData () as AvailableLength and ForceRetrieve set to FALSE .

In case of a UDP socket connection the SoAd shall copy (the requested part of) the PDU from the SoAd TP transmit buffer to the memory specified by parameter BufPtr within SoAd_CopyTxData ().

In case of a TCP socket connection the SoAd shall forward the request to the related upper layer by calling <Up>_[SoAd][Tp]CopyTxData () to copy (the requested part of) the PDU to the memory specified by parameter BufPtr within SoAd_CopyTxData ().

In case of a UDP socket connection the SoAd shall call the upper layer with the configured transmit confirmation function <Up>_[SoAd][Tp] TxConfirmation () and E_OK as result within the SoAd_MainFunction () after TcpIp_UdpTransmit () returns with TCPIP_OK .

In case of a TCP socket connection configured with SoAdSock- etTcpImmediateTpTxConfirmation set to FALSE the SoAd shall call the upper layer with the configured transmit confirmation function <Up>_[SoAd][Tp]TxCon- firmation () and E_OK as result within the SoAd_TxConfirmation () callback func- tion after all TP PDU data have been confirmed for transmission.

In case PDU header option is enabled ( SoAdPduHeaderEn- able is TRUE ) for a socket connection, SoAd shall convert the message into a PDU within SoAd_RxIndication () according to the following: 1. assemble the PDU Header into a SoAd receive buffer if it is fragmented in multiple TCP segments 2. extract the PDU Header from the received message 3. select the related socket route according to the received PDU Header ID ( SoAd- RxPduHeaderId ); if no socket route can be found, simply discard the PDU and raise the runtime error SOAD_E_INV_PDUHEADER_ID . 4. use the length field of the PDU Header to identify the length of the actual PDU and the start of the next PDU to proceed with (2) until the end of the message is reached. If the remainder is smaller than a PDU Header or the indicated length within the header SoAd shall stop processing and ignore the rest of the message.

If SoAd_IfTransmit () is called with TxPduId specifying a SoAdPduRouteDest which belongs only to inactive RoutingGroups, SoAd shall al- ways skip the transmission for this SoAdPduRouteDest and shall consider the trans- mission as successful unless all SoAdPduRouteDest of a SoAdPduRoute belong only to inactive RoutingGroups. In the latter case SoAd shall return E_NOT_OK .

If SoAd_TpTransmit () is called with TxPduId specifying a SoAdPduRouteDest which belongs only to inactive RoutingGroups, SoAd shall al- ways skip the transmission for this SoAdPduRouteDest and shall consider the trans- mission as successful unless all SoAdPduRouteDest of a SoAdPduRoute belong only to inactive RoutingGroups. In the latter case SoAd shall return E_NOT_OK .

For the reception of a message from an UDP or TCP socket and forwarding of the received data as PDU to the related upper layer the SoAd shall 1. Identify the related socket connection and socket routes by using the SocketId provided at SoAd_RxIndication () 2. Filter messages according to the message acceptance policy 3. Convert the message into a PDU 4. Skip further processing if PDU length is 0 and ( SoAdPduHeaderEnable is FALSE or SoAdRxUpperLayerType is TP) 5. Call the upper layer type related reception functions of the configured upper layer module depending on the SoAdRxUpperLayerType specified in SoAdSock- etRouteDest configuration

In case PDU header option is disabled ( SoAdPduHeaderEn- able is FALSE ) for a socket connection, SoAd shall convert the received UDP or TCP message 1:1 into a PDU within SoAd_RxIndication (), i.e. each TCP segment and UDP message forms a separate PDU.

In case of a TCP socket connection the SoAd shall confirm the reception of all data either forwarded to the upper layer or finally handled by SoAd (e.g. discarded data or processed PDU Header) by calling TcpIp_TcpReceived () within SoAd_RxIndication () or SoAd_MainFunction () respectively.

SoAd shall process TP- and IF-PDUs independently and within each type according to the received order per socket connection.

SoAd shall preserve the order of received data when using a SoAd receive buffer.

SoAd shall perform the following further actions within the SoAd_RxIndication () function for reception of a PDU to an upper layer using the IF-API: 1. assemble all data of a fragmented IF-PDU into a SoAd receive buffer if PDU Header is used 2. call <Up>_[SoAd][If]RxIndication () of the related upper layer module (with RxPduId set to the ID specified by the upper layer module for the PDU referenced by SoAdRxPduRef) for each completely received PDU 3. dispatch the next IF-PDU (if any) if PDU Header mode is used

SoAd shall perform the following further actions within the SoAd_RxIndication () function for reception of a PDU from a socket connection with PDU Header mode disabled to an upper layer using the TP-API: 1. if the SoAd receive buffer does not contain any TP data for this socket connection (a) Query the available amount of data at the upper layer by calling the config- urable callback function <Up>_[SoAd][Tp]CopyRxData () with PduInfo- Type.SduLength = 0. (b) If not all data can be processed (i.e. forwarded to an upper layer or stored in a SoAd receive buffer), discard all received data and skip further processing. (c) Copy all received data which can be accepted by the upper layer module determined at (a) to the upper layer by calling <Up>_[SoAd][Tp]CopyRx- Data () (d) Copy all remaining data (i.e. data which are received but not delivered to the upper layer) to a SoAd receive buffer for later processing by SoAd_- MainFunction () 2. if the SoAd receive buffer already contains TP data for this socket connection and is able to store all (newley) received data: copy all received data to the SoAd receive buffer for later processing by SoAd_MainFunction ()

In the SoAd_MainFunction () the SoAd shall process as spec- ified below if the SoAd receive buffer contains TP data for a socket connection with PDU Header mode disabled: 1. Query the available amount of data at the upper layer by calling the configurable callback function <Up>_[SoAd][Tp]CopyRxData () with PduInfoType.Sdu- Length = 0. 2. Copy all data belonging to this socket connection from the SoAd receive buffer which can be accepted by the upper layer module determined at (1) to the upper layer by calling <Up>_[SoAd][Tp]CopyRxData ()

If <Up>_[SoAd][Tp]StartOfReception () or <Up>_- [SoAd][Tp]CopyRxData () return with BUFREQ_E_NOT_OK for a socket connection with PDU Header mode disabled, SoAd shall (a) disable further transmission or re- ception for this socket connection (i.e. new transmit requests shall be rejected with E_NOT_OK and received messages shall simply be discarded) and (b) close the socket connection in the next SoAd_MainFunction ().

SoAd shall perform the following further actions within the SoAd_RxIndication () function for reception of a PDU from a socket connection with PDU Header mode enabled to an upper layer using the TP-API: 1. if no TP reception is in progress for the related socket connection (a) After reception of a complete PDU Header, call <Up>_[SoAd][Tp] StartOfReception () of the related upper layer module with RxPduId set to the ID specified by the upper layer module for the PDU referenced by SoAdRxPduRef , set TpSduLength to the length specified in the PDU Header, and set PduInfoType.SduDataPtr and PduInfoType.Sdu- Length to provide already received PDU data to the upper layer. (b) if not all data can be processed (i.e. forwarded to an upper layer or stored in a SoAd receive buffer), discard all received data, call <Up>_[SoAd][Tp] RxIndication ()with the same RxPduId as used at <Up>_[SoAd][Tp] StartOfReception () and result set to E_NOT_OK and skip further pro- cessing (c) call <Up>_[SoAd][Tp]CopyRxData () of the related upper layer module with the same RxPduId as used at <Up>_[SoAd][Tp]StartOfRecep- tion () and PduInfoType.SduDataPtr pointing to the PDU data pro- vided by SoAd_RxIndication () and PduInfoType.SduLength set to minimum of the received PDU data and the available receive buffer in the upper layer module specified by bufferSizePtr at <Up>_[SoAd][Tp] StartOfReception ()) (d) call <Up>_[SoAd][Tp]RxIndication () if the complete PDU has been forwarded to the upper layer, otherwise copy all received data which could not be forwarded to the upper layer to a SoAd receive buffer for later pro- cessing by SoAd_MainFunction () 2. if a TP reception is in progress for the related socket connection and the related SoAd receive buffer is able to store all received data: copy all received data to the related SoAd receive buffer for later processing by SoAd_MainFunction ()

If <Up>_[SoAd][Tp]StartOfReception () does not return BUFREQ_OK for a socket connection with PDU Header mode enabled, SoAd shall sim- ply discard all data of the PDU.

If <Up>_[SoAd][Tp]CopyRxData () does not return BUFREQ_OK for a socket connection with PDU Header mode enabled, SoAd shall terminate the TP receive session, simply discard all data of the PDU and call <Up>_[SoAd][Tp]RxIndication () with E_NOT_OK .

In the SoAd_MainFunction () the SoAd shall process as spec- ified below if a TP reception is in progress for a socket connection with PDU Header mode enabled: 1. Query the available amount of data at the upper layer by calling the configurable callback function <Up>_[SoAd][Tp]CopyRxData () with PduInfoType.Sdu- Length = 0. 2. Copy all data belonging to this socket connection from the SoAd receive buffer which can be accepted by the upper layer module determined at (1) to the upper layer by calling <Up>_[SoAd][Tp]CopyRxData () 3. call <Up>_[SoAd][Tp]RxIndication () if the complete PDU has been for- warded to the upper layer and dispatch the next TP-PDU (if any)

SoAd shall store a cancellation request when called with SoAd_TpCancelReceive () and SoAd_TpCancelTransmit (), but handle the re- quest only in the SoAd_MainFunction () respecting the connection loss and recovery policy.

If SoAd_TpCancelReceive () or SoAd_TpCancelTrans- mit () is called for a PDU where TP reception or TP transmission is not in progress, SoAd shall ignore the request and return E_NOT_OK .

Within SoAd_MainFunction (), SoAd shall close the socket connection for any communication cancelation request related to an active TP trans- mission.

Within SoAd_MainFunction (), SoAd shall close the socket connection for any communication cancelation request related to an active TP recep- tion.

For a UDP socket connection of type automatic (i.e. config- uration parameter SoAdSocketAutomaticSoConSetup set to TRUE ) which uses a wildcard in the configured remote address (i.e. an ANY-String for IP address or port), SoAd shall (a) change the state of the socket connection to SOAD_SOCON_RECONNECT and (b) reset the remote address to the configured remote address after a PDU trans- mission, directly before the related transmit confirmation function is called (or would be called if such a function is not configured).

SoAd shall automatically reestablish a socket connection which is in the connection state SOAD_SOCON_RECONNECT within SoAd_MainFunction () - independent of the configuration parameter SoAdSocketAutomaticSoConSetup , i.e. connection shall be reestablished even if the parameter is set to FALSE . Recon- nection shall be done by considering configuration parameter SoAdSocketTcpIni- tiate .

SoAd shall return E_NOT_OK for TP-PDU Tx requests received at SoAd_TpTransmit () within connection reestablishment.

SoAd shall store a request to open or close a socket connection when called with SoAd_OpenSoCon () and SoAd_CloseSoCon () respectively, but han- dle the request only in the SoAd_MainFunction () respecting the connection setup and shutdown policy.

In the SoAd_MainFunction (), SoAd shall try to open each socket connection which fulfills all of the following criterias: 1. No TcpIp socket is assigned to the socket connection 2. Open is either (a) explicitly requested by a previous SoAd_OpenSoCon () call which has not been revoked by a following SoAd_CloseSoCon () call or (b) im- plicitly requested when SoAdSocketAutomaticSoConSetup is TRUE 3. remote address is set (either specified by configuration or set via the function SoAd_SetRemoteAddr ()) 4. local IP address is assigned, i.e. SoAd_LocalIpAddrAssign- mentChg () has been called with the related LocalAddrId and TCPIP_IPADDR_STATE_ASSIGNED as State.

SoAd shall perform the following actions within SoAd_Main- Function () to open either a UDP socket connection which is part of a socket con- nection group containing a single socket connection (i.e. there is only one socket connection in the socket connection group configuration container) or a TCP socket connection with SoAdSocketTcpInitiate set to TRUE : 1. Get an appropriate socket from TcpIp by calling TcpIp_SoAdGetSocket () with the TcpIp_DomainType implicitly specified by SoAdSocketLocalAddress- Ref , and the protocol type specified by SoAdSocketProtocol . 2. Change the socket specific parameters according to [SWS_SoAd_00689]. 3. Bind the socket to the local address and port by calling TcpIp_Bind () with the local address identifier specified by SoAdSocketLocalAddressRef and local port specified by SoAdSocketLocalPort . 4. In case of a TCP socket initiate the TCP connection by calling TcpIp_TcpCon- nect ().

Within SoAd_MainFunction () and after successfully perform- ing the open actions, SoAd shall change the state of the socket connection to SOAD_SOCON_ONLINE in case of a UDP socket and either SoAdSocketUdpLis- tenOnly is set to TRUE or a remote address is set by a value that does not contain any wildcards.

Within SoAd_RxIndication () and before analyzing or for- warding of any message data, SoAd shall (a) overwrite the remote address parts specified with wildcards (e.g. remote IP address set to TCPIP_IPADDR_ANY ) with the related source address parts of the received message and (b) change the state of the socket connection to SOAD_SOCON_ONLINE in case all of the following conditions are true: 1. Current connection state is not SOAD_SOCON_ONLINE 2. UDP socket 3. SoAdSocketUdpListenOnly is set to FALSE 4. SoAdSocketMsgAcceptanceFilterEnabled is set to TRUE 5. Remote address is set, but contains wildcards 6. Received message is accepted according to the message acceptance policy

Within SoAd_TcpConnected () SoAd shall change the state of the socket connection to SOAD_SOCON_ONLINE in case all of the following conditions are true: 1. Current connection state is not SOAD_SOCON_ONLINE 2. TCP socket 3. SoAdSocketTcpInitiate is set to TRUE

At SoAd_TcpAccepted (), SoAd shall perform the following ac- tions if the TCP SoAdSocketConnectionGroup related to SocketId has SoAd- SocketTcpInitiate set to FALSE : 1. choose one of the socket connections using the best match algorithm (see [SWS_SoAd_00680]), and either proceed with the selected socket connection or skip further processing and return with E_NOT_OK if no match can be found 2. overwrite the remote address parts specified with wildcards (e.g. remote IP ad- dress set to TCPIP_IPADDR_ANY ) with the related source address parts of the received message if the remote address set for the socket connection contains wildcards 3. assign the TcpIp socket used for the established connection and provided as parameter SocketIdConnected to the chosen socket connection, 4. change the state of this socket connection to SOAD_SOCON_ONLINE and return E_OK

For socket connection with PDU Header mode disabled ( SoAd- PduHeaderEnable = FALSE ) and an upper layer with TP-API, SoAd shall call <Up> _[SoAd][Tp]StartOfReception () with TpSduLength = 0 at the end of the con- nection setup.

Each time a socket connection state changes, SoAd shall notify the upper layer of a socket connection state change with the configured upper layer notification function <Up>_SoConModeChg () and the new state if SoAdSocketSo- ConModeChgNotification is set to TRUE for the socket connection.

Each time the IP address assignment related to a socket con- nection changes, SoAd shall notify the upper layer of the IP address assignment change with the configured upper layer notification function <Up>_LocalIpAddrAs- signmentChg () and the new address state if SoAdSocketIpAddrAssignmentChg- Notification is set to TRUE for the socket connection.

The SoAd shall provide sufficient buffers to store data which temporarily can't be forwarded to TcpIp, e.g. SoAd UDP TP transmit buffers or Udp- TxBuffer, nPduUdpTxBuffer.

If a PDU is received according to SoAdSocketRouteDest which belongs only to inactive RoutingGroups, SoAd shall simply discard the PDU.

SoAd shall maintain the state of each configured routing group and activate or deactivate the state at initialization depending on the configuration pa- rameter SoAdRoutingGroupIsEnabledAtInit .

SoAd shall support more than one SoAdPduRouteDest per SoAdPduRoute for upper layers of If-type, i.e. a single IF-PDU can be transmitted via multiple socket connections.

In the SoAd_MainFunction (), SoAd shall close each socket connection which fulfills all of the following criteria: 1. Current connection state is not SOAD_SOCON_OFFLINE 2. Close is explicitly requested by a previous SoAd_CloseSoCon () call 3. No upper layer requested to keep the socket connection open at the time of the SoAd_CloseSoCon () call (i.e. SoAd_CloseSoCon () has been called as often as SoAd_OpenSoCon ()) or SoAd_CloseSoCon () has been called with abort set to TRUE .

If development error detection is enabled: SoAd_TpCancel- Transmit () shall check that the service SoAd_Init () was previously called. If the check fails, SoAd_TpCancelTransmit () shall raise the development error SOAD_E_UNINIT .

If development error detection is enabled: SoAd_TpCancel- Transmit () shall check parameter TxPduId for being valid. If the check fails, SoAd_- TpCancelTransmit () shall raise the development error SOAD_E_INV_PDUID .

If development error detection is enabled: SoAd_TpCancel- Receive () shall check that the service SoAd_Init () was previously called. If the check fails, SoAd_TpCancelReceive () shall raise the development error SOAD_E_UNINIT .

If development error detection is enabled: SoAd_TpCancel- Receive () shall check parameter RxPduId for being valid. If the check fails, SoAd_- TpCancelReceive () shall raise the development error SOAD_E_INV_PDUID .

If development error detection is enabled: SoAd_GetSo- ConId () shall check that the service SoAd_Init () was previously called. If the check fails, SoAd_GetSoConId () shall raise the development error SOAD_E_UNINIT .

If development error detection is enabled: SoAd_GetSo- ConId () shall check parameter TxPduId for being valid. If the check fails, SoAd_- GetSoConId () shall raise the development error SOAD_E_INV_PDUID .

If development error detection is enabled: SoAd_OpenSoCon () shall check parameter SoConId for being valid. If the check fails, SoAd_OpenSoCon () shall raise the development error SOAD_E_INV_ARG .

If development error detection is enabled: SoAd_CloseSo- Con () shall check parameter SoConId for being valid. If the check fails, SoAd_Clos- eSoCon () shall raise the development error SOAD_E_INV_ARG .

If development error detection is enabled: SoAd_RequestI- pAddrAssignment () shall check that the service SoAd_Init () was previously called. If the check fails, SoAd_RequestIpAddrAssignment () shall raise the development error SOAD_E_UNINIT .

If development error detection is enabled: SoAd_OpenSoCon () shall check that the service SoAd_Init () was previously called. If the check fails, SoAd_OpenSoCon () shall raise the development error SOAD_E_UNINIT .

If development error detection is enabled: SoAd_CloseSo- Con () shall check that the service SoAd_Init () was previously called. If the check fails, SoAd_CloseSoCon () shall raise the development error SOAD_E_UNINIT .

If development error detection is enabled, SoAd_RequestI- pAddrAssignment () shall check parameter SoConId for being valid. If the check fails, SoAd_RequestIpAddrAssignment () shall raise the development error SOAD_E_INV_ARG .

If development error detection is enabled: SoAd_Relea- seIpAddrAssignment () shall check that the service SoAd_Init () was previously called. If the check fails, SoAd_ReleaseIpAddrAssignment () shall raise the devel- opment error SOAD_E_UNINIT .

If development error detection is enabled: SoAd_Relea- seIpAddrAssignment () shall check parameter SoConId for being valid. If the check fails, SoAd_ReleaseIpAddrAssignment () shall raise the development error SOAD_E_INV_ARG .

If development error detection is enabled: SoAd_GetLocal- Addr () shall check parameter SoConId for being valid. If the check fails, SoAd_Get- LocalAddr () shall raise the development error SOAD_E_INV_ARG .

If development error detection is enabled: SoAd_GetLocal- Addr () shall check that the service SoAd_Init () was previously called. If the check fails, SoAd_GetLocalAddr () shall raise the development error SOAD_E_UNINIT .

If development error detection is enabled: SoAd_Get- PhysAddr () shall check parameter SoConId for being valid. If the check fails, SoAd_- GetPhysAddr () shall raise the development error SOAD_E_INV_ARG .

If development error detection is enabled: SoAd_Get- PhysAddr () shall check that the service SoAd_Init () was previously called. If the check fails, SoAd_GetPhysAddr () shall raise the development error SOAD_E_UNINIT .

If development error detection is enabled: SoAd_EnableR- outing () shall check that the service SoAd_Init () was previously called. If the check fails, SoAd_EnableRouting () shall raise the development error SOAD_E_UNINIT .

If development error detection is enabled: SoAd_EnableR- outing () shall check parameter id for being valid. If the check fails, SoAd_EnableR- outing () shall raise the development error SOAD_E_INV_ARG .

If development error detection is enabled: SoAd_DisableR- outing () shall check parameter id for being valid. If the check fails, SoAd_DisableR- outing () shall raise the development error SOAD_E_INV_ARG .

If development error detection is enabled: SoAd_DisableR- outing () shall check that the service SoAd_Init () was previously called. If the check fails, SoAd_DisableRouting () shall raise the development error SOAD_E_UNINIT .

If development error detection is enabled: SoAd_Se- tRemoteAddr () shall check that the service SoAd_Init () was previously called. If the check fails, SoAd_SetRemoteAddr () shall raise the development error SOAD_E_UNINIT .

If development error detection is enabled: SoAd_CopyTx- Data () shall check that the service SoAd_Init () was previously called. If the check fails, SoAd_CopyTxData () shall raise the development error SOAD_E_UNINIT .

If development error detection is enabled: SoAd_CopyTx- Data () shall check parameter SocketId for being valid. If the check fails, SoAd_- CopyTxData () shall raise the development error SOAD_E_INV_SOCKETID .

If SoAdSocketMsgAcceptanceFilterEnabled is FALSE , SoAd shall accept all TCP connection or UDP datagrams from remote nodes.

At SoAd_TcpAccepted (), SoAd shall perform the following actions if the TCP SoAdSocketConnectionGroup related to SocketId has both SoAdSocketTcpInitiate and SoAdSocketMsgAcceptanceFilterEnabled set to FALSE and is not online (i.e. current connection state not SOAD_SOCON_ONLINE ): 1. assign the TcpIp socket used for the established connection and provided as parameter SocketIdConnected to the socket connection and 2. change the state of the socket connection to SOAD_SOCON_ONLINE and return E_OK .

SoAd shall perform the following actions within SoAd_Main- Function () to close a socket connection: 1. Terminate active TP sessions (if any) and notify the upper layer about the termi- nation 2. Disable further transmission or reception for this socket connection, i.e. new transmit requests shall be rejected with E_NOT_OK and received messages shall simply be discarded. 3. Close related TcpIp sockets 4. Change the state of the socket connection to SOAD_SOCON_OFFLINE if clos- ing of the socket connection results from a SoAd_CloseSoCon () request or to SOAD_SOCON_RECONNECT otherwise.

SoAd shall perform the following actions within SoAd_Main- Function () to open a TCP socket connection with SoAdSocketTcpInitiate set to FALSE : 1. In case no Listen-Socket is assigned to the socket connection: (a) Get an appropriate socket from TcpIp by calling TcpIp_SoAdGetSocket () with the TcpIp_DomainType implicitly specified by SoAdSocketLocal- AddressRef , and the protocol type specified by SoAdSocketProtocol . (b) Change the socket specific parameters according to [SWS_SoAd_00689]. (c) Bind the socket to the local address and port by calling TcpIp_Bind () with the local address identifier specified by SoAdSocketLocalAddressRef and local port specified by SoAdSocketLocalPort . (d) Assign the Listen-Socket to the socket connection group (e) Activate the socket connection to accept connections from remote nodes (f) Listen for a remote connection requests on the Listen-Socket by calling TcpIp_TcpListen () with MaxChannels set to the number of socket con- nections that are part of the TCP socket connection group 2. In case the Listen-Socket is already assigned to the socket connection: (a) Activate the socket connection to accept connections from remote nodes

SoAd shall perform the following actions within SoAd_Main- Function () to open a UDP socket connection which is part of a socket connection group containing multiple socket connections (i.e. there is more than one socket con- nection in the socket connection group configuration container): 1. In case no UDP socket is assigned to the socket connection group: (a) Get an appropriate socket from TcpIp by calling TcpIp_SoAdGetSocket () with the domain type implicitly specified by SoAdSocketLocalAddress- Ref , and the protocol type specified by SoAdSocketProtocol . (b) Change the socket specific parameters according to [SWS_SoAd_00689] (c) Bind the socket to the local address and port by calling TcpIp_Bind () with the local address identifier specified by SoAdSocketLocalAddressRef and local port specified by SoAdSocketLocalPort . (d) Assign the UDP socket to the socket connection group (e) Activate the socket connection for communication via the shared UDP socket of the socket connection group 2. In case the UDP socket is already assigned to the socket connection group: (a) Activate the socket connection for communication via the shared UDP socket of the socket connection group

To notify the upper layer about the termination of an active TP transmission on closing a socket connection within SoAd_MainFunction (), SoAd shall call <Up>_[SoAd][Tp]TxConfirmation () with parameter result set to 1. E_OK if disconnect is caused by SoAd_CloseSoCon () and all data was correctly transmitted, and 2. E_NOT_OK for any other cause.

To notify the upper layer about the termination of an active TP reception on closing a socket connection within SoAd_MainFunction (), SoAd shall call <Up>_[SoAd][Tp]RxIndication () with parameter result set to 1. E_OK if disconnection is caused by SoAd_CloseSoCon () and all received data was correctly delivered to the upper layer, and 2. E_NOT_OK for any other cause.

To close related TcpIp sockets on closing a socket connection within SoAd_MainFunction (), SoAd shall perform the following actions: 1. In case of a TCP socket connection: (a) Close the related socket by calling TcpIp_Close () with parameter abort set to the same value as provided by SoAd_CloseSoCon () or set to FALSE in case closing was not initiated by SoAd_CloseSoCon (). (b) If all socket connections of a TCP socket connection group have been closed by SoAd_CloseSoCon (): Close the related Listen-Socket by call- ing TcpIp_Close () with parameter abort set to the same value as provided by SoAd_CloseSoCon () or set to FALSE in case closing was not initiated by SoAd_CloseSoCon (). 2. In case of a UDP socket connection: (a) If the socket connection is NOT part of a socket connection group (i.e. there is only one socket connection in the socket connection group configuration container): Close the related socket by calling TcpIp_Close () with param- eter abort set to the same value as provided by SoAd_CloseSoCon () or set to FALSE in case closing was not initiated by SoAd_CloseSoCon (). (b) If all socket connections of a UDP socket connection group have been closed by SoAd_CloseSoCon (): Close the related UDP socket by calling TcpIp_- Close () with parameter abort set to the same value as provided by SoAd_- CloseSoCon ()or set to FALSE in case closing was not initiated by SoAd_- CloseSoCon ().

Within SoAd_TcpIpEvent () with Event set to TCPIP_UDP_CLOSED , SoAd shall 1. remove the assignment of the TcpIp socket identified by SocketId from the related UDP socket connection group and 2. close all socket connections of the related socket connection group that are in SOAD_SOCON_ONLINE (i.e. perform the specified closing actions with the excep- tion of closing related TcpIp sockets)

For a TCP socket connection of type automatic (i.e. configu- ration parameter SoAdSocketAutomaticSoConSetup set to TRUE ) which uses a wildcard in the configured remote address (i.e. an ANY-String for IP address or port), SoAd shall (a) disable further transmission or reception for this socket connection (i.e. new transmit requests shall be rejected with E_NOT_OK and received messages shall simply be discarded) after a PDU transmission, directly before the related transmit con- firmation function is called (or would be called if such a function is not configured) and (b) close the socket connection in the next SoAd_MainFunction ().

Within SoAd_TcpIpEvent () with Event set to TCPIP_TCP_CLOSED for a Listen-Socket, SoAd shall remove the assignment of the TcpIp socket identified by SocketId from the related TCP socket connection group.

Within SoAd_TcpIpEvent () with Event set to TCPIP_TCP_CLOSED or TCPIP_TCP_RESET , SoAd shall 1. remove the assignment of the TcpIp socket identified by SocketId from the related socket connection and 2. close the socket connection if it is in SOAD_SOCON_ONLINE (i.e. perform the specified closing actions with the exception of closing related TcpIp socket).

In case of multiple socket connections, SoAd shall call the up- per layer with the configured transmit confirmation function ( <Up>[SoAd][If]Tx- Confirmation ()) with result set to E_OK only once after transmission on all related socket connections succeded.

If a transmit request on any of multiple socket connections re- turns E_NOT_OK , SoAd shall return E_NOT_OK at SoAd_IfTransmit ().

The service SoAd_TpTransmit () shall skip the transmit re- quest and return E_NOT_OK if there is already an IF or TP transmission ongoing on the related socket identified by TxPduId .

If <Up>_[SoAd][Tp]CopyTxData () return with BUFREQ_E_NOT_OK for a TCP socket connection, SoAd shall (a) disable further transmission or reception for this socket connection (i.e. new transmit requests shall be rejected with E_NOT_OK and received messages shall simply be discarded) and (b) close the socket connection in the next SoAd_MainFunction ().

If <Up>_[SoAd][Tp]CopyTxData () return with BUFREQ_E_NOT_OK for a UDP socket connection, SoAd shall immediately ter- minate the TP transmit session and notify the upper layer with the configured transmit confirmation function <Up>_[SoAd][Tp]TxConfirmation () with E_NOT_OK as result. (Note: the related socket connection is not closed in this case.)

The service SoAd_IfTransmit () shall skip the transmit re- quest and return E_NOT_OK if there is already an IF or TP transmission ongoing on the related socket identified by TxPduId .

In case more than one socket connection belongs to a UDP socket connection group, a UDP socket is shared between all socket connections of the group and the related socket connection shall be selected according to the best match algorithm (see [SWS_SoAd_00680]).

If development error detection is enabled: SoAd_IfRouting- GroupTransmit () shall check parameter id for being valid (i.e. id refers a routing group that has configuration parameter SoAdRoutingGroupTxTriggerable set to TRUE ). If the check fails, SoAd_IfRoutingGroupTransmit () shall raise the devel- opment error SOAD_E_INV_ARG .

If development error detection is enabled: SoAd_Ge- tRemoteAddr () shall check that the service SoAd_Init () was previously called. If the check fails, SoAd_GetRemoteAddr () shall raise the development error SOAD_E_UNINIT .

If development error detection is enabled: SoAd_Ge- tRemoteAddr () shall check parameter SoConId for being valid. If the check fails, SoAd_GetRemoteAddr () shall raise the development error SOAD_E_INV_ARG .

If development error detection is enabled: SoAd_IfRouting- GroupTransmit () shall check that the service SoAd_Init () was previously called. If the check fails, SoAd_IfRoutingGroupTransmit () shall raise the development error SOAD_E_UNINIT .

At SoAd_IfRoutingGroupTransmit () SoAd shall store a trigger transmit request for each SoAdPduRouteDest that contains a reference to the routing group identified by the parameter id for transmission in the SoAd_Main- Function ().

At SoAd_GetRemoteAddr () SoAd shall retrieve the remote ad- dress (IP address and port) actually used for the socket connection specified by pa- rameter SoConId .

In the SoAd_MainFunction () the SoAd shall check for pend- ing triggered transmit request for SoAdPduRouteDest and identify all related IF- PDUs. For each identified IF-PDU SoAd shall process as specified below: 1. retrieve the data from the related upper layer by calling <Up>_[SoAd][If] TriggerTransmit () and 2. transmit the data via the related socket connection.

SoAd_GetRemoteAddr () shall immediately return E_NOT_OK if the remote address of the socket connection specified by parameter SoConId is not set.

In case of a TCP socket connection configured with SoAdSock- etTcpImmediateTpTxConfirmation set to TRUE the SoAd shall call the upper layer with the configured transmit confirmation function <Up>_[SoAd][Tp]TxCon- firmation () and E_OK as result within the SoAd_MainFunction () after TcpIp_- TcpTransmit () returns E_OK .

In case of a TCP socket connection the SoAd shall call the upper layer with the configured transmit confirmation function <Up>_[SoAd][Tp]Tx- Confirmation () and E_NOT_OK as result within the SoAd_MainFunction () after TcpIp_TcpTransmit () returns with E_NOT_OK .

If development error detection is enabled: SoAd_SetUni- queRemoteAddr () shall check that the service SoAd_Init () was previously called. If the check fails, SoAd_SetUniqueRemoteAddr () shall raise the development error SOAD_E_UNINIT .

If development error detection is enabled: SoAd_SetU- niqueRemoteAddr () shall check parameter SoConId for being valid. If the check fails, SoAd_SetUniqueRemoteAddr () shall raise the development error SOAD_E_INV_ARG

The function SoAd_SetUniqueRemoteAddr () shall check if one of the socket connections of the socket connection group, identified by SoConId , is already configured with the address specified by RemoteAddrPtr. In this case, it shall return the socket connection index via AssignedSoConIdPtr and return E_OK .

If no socket connection is already configured with the address specified by RemoteAddrPtr, SoAd_SetUniqueRemoteAddr () shall: 1. choose an unused socket connection using the best match algorithm described in [SWS_SoAd_00680] 2. set it to the remote address specified by RemoteAddrPtr 3. set AssignedSoConIdPtr to the index of the chosen socket connection and 4. return E_OK . A socket connection is "unused" if its actual remote address has an IP address wildcard and/or port wildcard.

SoAd_SetUniqueRemoteAddr () shall reject the request and return E_NOT_OK if there are no unused socket connections within the socket connec- tion group identified by SoConId .

SoAd shall use the following best match algorithm to select a socket connection of a socket connection group based on a provided (specific) remote address: 1. socket connections that have no (specific or wildcard) remote address set shall be ignored 2. the remote address of the remaining socket connections shall be compared with the provided remote address and the socket connection with the best match ac- cording to the following ordered list (item listed earlier has higher priority towards items listed later) shall be selected: (a) IP address and port match (b) IP address match (and wildcard set for port) (c) Port match (and wildcard set for IP address) (d) Wildcards are used for both IP address and port (e) No match (i.e. no socket connections can be selected)

If a PDU with SoAdTxUdpTriggerMode set to TRIG- GER_NEVER without a specific SoAdTxUdpTriggerTimeout get buffered SoAd shall set the the nPdu specific timer to the value of SoAdTxUdpTriggerTimeout if the timer is not running or if it is lower than the current nPdu specific timer value.

SoAd shall stop the nPdu specific timer when the PDUs stored for the socket connection have been sent

In case the nPdu feature is used for a socket connection and SoAdTxUdpTriggerMode is set to TRIGGER_ALWAYS for the current PDU ( SoAdP- duRouteDest ) and the resulting PDU data and headers would exceed SoAdSocket- nPduUdpTxBufferMin , SoAd shall first transmit all PDUs stored for the socket con- nection (if any) by calling TcpIp_UdpTransmit () and then the current PDU by calling TcpIp_UdpTransmit () once more.

Within SoAd_MainFunction () and after successfully perform- ing the open actions, SoAd shall change the state of the socket connection to SOAD_SOCON_RECONNECT in case of 1. a TCP socket connection or 2. a UDP socket connection that is configured with a remote address containing wildcards.

If the function SoAd_SetRemoteAddr () is used to set the re- mote address of a socket connection that is in the mode SOAD_SOCON_ONLINE to a value that contains wildcards, SoAd shall change the mode of the socket connection to SOAD_SOCON_RECONNECT .

Within SoAd_TcpIpEvent () with Event set to TCPIP_TCP_FIN_RECEIVED SoAd shall close the related socket by calling TcpIp_- Close () with parameter abort set FALSE .

In case socket related parameters shall be changed as part of allocating a new socket, SoAd shall change the parameters according to the configura- tion of the associated socket connection by calling TcpIp_ChangeParameter () with ParameterId and ParameterValue for each related clause as specified below: 1. In case of a TCP socket: TCPIP_PARAMID_TCP_RXWND_MAX and the value specified by SoAdSocketTpRxBufferMin if the optional parameter is enabled 2. TCPIP_PARAMID_FRAMEPRIO and the value specified by SoAdSocket- FramePriority if the optional parameter is enabled 3. In case of a TCP socket: TCPIP_PARAMID_TCP_NAGLE and the value 0x01 if the related optional parameter SoAdSocketTcpNoDelay is set to FALSE or 0x00 if the parameter is set to TRUE . 4. In case of a TCP socket: TCPIP_PARAMID_TCP_KEEPALIVE and the value specified by SoAdSocketTcpKeepAlive 5. In case of a TCP socket: TCPIP_PARAMID_TCP_KEEPALIVE_TIME and the value specified by SoAdSocketTcpKeepAliveTime if the optional parameter is enabled 6. In case of a TCP socket: TCPIP_PARAMID_TCP_KEEPALIVE_PROBES_MAX and the value specified by SoAdSocketTcpKeepAliveProbesMax if the op- tional parameter is enabled 7. In case of a TCP socket: TCPIP_PARAMID_TCP_KEEPALIVE_INTERVAL and the value specified by SoAdSocketTcpKeepAliveInterval if the optional pa- rameter is enabled. 8. In case of a TCP socket: TCPIP_PARAMID_TCP_OPTIONFILTER and the value of TcpIpTcpConfigOptionFilterId specified in TcpIpTcpCon- figOptionFilter referenced by SoAdSocketTCPOptionFilterRef if the optional parameter is enabled. 9. TCPIP_PARAMID_PATHMTU_ENABLE and the value specified by SoAdSocket- PathMTUEnable if the optional parameter is enabled. 10. TCPIP_PARAMID_FLOWLABEL and the value specified by SoAdSocket- FlowLabel if the optional parameter is enabled. 11. TCPIP_PARAMID_DSCP and the value specified by SoAdSocketDifferenti- atedServicesField if the optional parameter is enabled. 12. In case of a UDP socket: TCPIP_PARAMID_UDP_CHECKSUM and the value of SoAdSocketUdpChecksumEnabled . 13. In case of a TCP socket: If SoAdSocketTcpTlsConnection- Ref is defined the function shall be called with the parameter ID TCPIP_PARAMID_TLS_CONNECTION_ASSIGNMENT and the value from this reference as the parameter value to assign a TLS connection to this socket. 14. In case of a TCP socket: TCPIP_PARAMID_TCP_RETRANSMIT_TIMEOUT and the value specified by SoAdSocketTcpRetransmissionTimeout if the op- tional parameter is enabled. If SoAdSocketTcpRetransmissionTimeout is configured to INF , SoAd shall use the corresponding value representing INF from TcpIp module.

SoAd shall preserve the order of PDUs transmitted via a socket connection that uses the nPdu feature. Pdus collected on the sender side first shall be extracted and indicated to the receivers on the receiving side first as well.

In case the nPdu feature is used for a socket connection and and all PDUs are configured with SoAdTxPduCollectionSemantics set to SOAD_COLLECT_QUEUED , SoAd shall transmit all PDUs individually, also PDUs with the same PduId.

Det_ReportError Det.h Service to report development errors. IdsM_SetSecurityEvent IdsM.h This API is the application interface to report security events to the IdsM. IdsM_SetSecurityEventWithContext Data IdsM.h This API is the application interface to report security events with context data to the IdsM. API Function Header File Description PduR_SoAdTpCopyRxData PduR_SoAd.h This function is called to provide the received data of an I-PDU segment (N-PDU) to the upper layer. Each call to this function provides the next part of the I-PDU data. The size of the remaining buffer is written to the position indicated by bufferSizePtr. PduR_SoAdTpCopyTxData PduR_SoAd.h This function is called to acquire the transmit data of an I-PDU segment (N-PDU). Each call to this function provides the next part of the I-PDU data unless retry->TpDataState is TP_DATARETRY. In this case the function restarts to copy the data beginning at the offset from the current position indicated by retry->TxTpDataCnt. The size of the remaining data is written to the position indicated by availableDataPtr. TcpIp_DhcpReadOption TcpIp.h By this API service the TCP/IP stack retrieves DHCP option data identified by parameter option for already received DHCP options. TcpIp_DhcpV6ReadOption TcpIp.h By this API service the TCP/IP stack retrieves DHCPv6 option data identified by parameter option for already received DHCPv6 options. TcpIp_DhcpV6WriteOption TcpIp.h By this API service the TCP/IP stack writes the DHCPv6 option data identified by parameter option. TcpIp_DhcpWriteOption TcpIp.h By this API service the TCP/IP stack writes the DHCP option data identified by parameter option.

Whenever a PDU or a part of a PDU is received, that has to be stored in a SoAd receive buffer, is larger than the remaining available buffer size SoAd shall shall raise the runtime error SOAD_E_NOBUFS .

If a UDP socket connection is configured with a SoAdSocke- tUdpAliveSupervisionTimeout and the remote address was overwritten, as de- scribed in [SWS_SoAd_00592], the alive supervision timer for this socket connection shall be started with the value specified by the configuration parameter SoAdSocke- tUdpAliveSupervisionTimeout .

If a UDP socket connection is configured with a SoAdSocke- tUdpAliveSupervisionTimeout , the alive supervision timer runs out and the re- mote address was not set by the upper layer, SoAd shall 1. change the state of the socket connection to SOAD_SOCON_RECONNECT , 2. deactivate the alive supervision timer and 3. reset the remote address to the configured remote address at SoAd_MainFunc- tion ().

SoAd shall maintain a nPdu specific timer for each socket con- nection using the nPdu feature.

If a PDU with SoAdTxUdpTriggerMode set to TRIG- GER_NEVER with a specific SoAdTxUdpTriggerTimeout get buffered SoAd shall set the nPdu specific timer to the value of SoAdTxUdpTriggerTimeout if the timer is not running or if it is lower than the current nPdu specific timer value.

SoAd_GetRemoteAddr () shall refuse the request if the domain set in IpAddrPtr does not match the TcpIp_DomainType of the local address related to the socket connection identified by SoConId and return E_NOT_OK . If development error detection is enabled, the service SoAd_GetRemoteAddr () shall also raise the development error SOAD_E_INV_ARG .

SoAd_SetRemoteAddr () shall refuse the request if the domain set in RemoteAddrPtr does not match the TcpIp_DomainType of the local address related to the socket connection identified by SoConId and return E_NOT_OK . If de- velopment error detection is enabled, the service SoAd_SetRemoteAddr () shall also raise the development error SOAD_E_INV_ARG .

SoAd_SetUniqueRemoteAddr () shall refuse the request if the domain set in RemoteAddrPtr does not match the TcpIp_DomainType of the local ad- dress related to the socket connection identified by SoConId and return E_NOT_OK . If development error detection is enabled, the service SoAd_SetUniqueRemoteAddr () shall also raise the development error SOAD_E_INV_ARG .

If development error detection is enabled: SoAd_Read- DhcpHostNameOption () shall check that the service SoAd_Init () was previously called. If the check fails, SoAd_ReadDhcpHostNameOption () shall raise the devel- opment error SOAD_E_UNINIT .

If development error detection is enabled: SoAd_Read- DhcpHostNameOption () shall check parameter SoConId for being valid. If the check fails, SoAd_ReadDhcpHostNameOption () shall raise the development error SOAD_E_INV_ARG .

The service SoAd_ReadDhcpHostNameOption () shall for- ward the call to TcpIp_DhcpReadOption () with the parameter Option set to the op- tion code 81 according to IETF RFC 4702 [9], if the socket connection identified by SoConId is related to a local address of the TcpIp_DomainType TCPIP_AF_INET.

The service SoAd_ReadDhcpHostNameOption () shall for- ward the call to TcpIp_DhcpV6ReadOption () with the parameter Option set to the option code 39 according to IETF RFC 4704 [10], if the socket connection identified by SoConId is related to a local address of the TcpIp_DomainType TCPIP_AF_INET6.

If development error detection is enabled: SoAd_WriteD- hcpHostNameOption () shall check that the service SoAd_Init () was previously called. If the check fails, SoAd_WriteDhcpHostNameOption () shall raise the de- velopment error SOAD_E_UNINIT .

If development error detection is enabled: SoAd_WriteD- hcpHostNameOption () shall check parameter SoConId for being valid. If the check fails, SoAd_WriteDhcpHostNameOption () shall raise the development error SOAD_E_INV_ARG .

The service SoAd_WriteDhcpHostNameOption () shall for- ward the call to TcpIp_DhcpWriteOption () with the parameter Option set to the option code 81 according to IETF RFC 4702 [9], if the socket connection identified by SoConId is related to a local address of the TcpIp_DomainType TCPIP_AF_INET.

The service SoAd_WriteDhcpHostNameOption () shall for- ward the call to TcpIp_DhcpV6WriteOption () with the parameter Option set to the option code 39 according to IETF RFC 4704 [10], if the socket connection identified by SoConId is related to a local address of the TcpIp_DomainType TCPIP_AF_INET6.

If SoAdSocketUdpStrictHeaderLenCheckEnabled is en- abled SoAd shall check if the length of the received UDP message does match the accumulated length of all PDUs including their PDU headers prior to forwarding any data to an upper layer. If the their lengths are different SoAd shall silently drop the whole message without forwarding any data.

In case no valid PDU data was forwarded to an upper layer and the remote address of the socket connection was overwritten according to [SWS_SoAd_00592] in context of the same SoAd_RxIndication (), SoAd shall re- vert the remote address change and set the state of the socket connection back to SOAD_SOCON_RECONNECT .

If development error detection is enabled: SoAd_IfSpecifi- cRoutingGroupTransmit () shall check that the service SoAd_Init () was previ- ously called. If the check fails, SoAd_IfSpecificRoutingGroupTransmit () shall raise the development error SOAD_E_UNINIT .

If development error detection is enabled: SoAd_IfSpecifi- cRoutingGroupTransmit () shall check parameter id for being valid (i.e. id refers a routing group that has configuration parameter SoAdRoutingGroupTxTriggerable set to TRUE ). If the check fails, SoAd_IfSpecificRoutingGroupTransmit () shall raise the development error SOAD_E_INV_ARG .

If development error detection is enabled: SoAd_Enable- SpecificRouting () shall check that the service SoAd_Init () was previously called. If the check fails, SoAd_EnableSpecificRouting () shall raise the development er- ror SOAD_E_UNINIT .

If development error detection is enabled: SoAd_Ena- bleSpecificRouting () shall check parameter id for being valid. If the check fails, SoAd_EnableSpecificRouting () shall raise the development error SOAD_E_INV_ARG .

If development error detection is enabled: SoAd_Disable- SpecificRouting () shall check that the service SoAd_Init () was previously called. If the check fails, SoAd_DisableSpecificRouting () shall raise the development error SOAD_E_UNINIT .

If development error detection is enabled: SoAd_Dis- ableSpecificRouting () shall check parameter id for being valid. If the check fails, SoAd_DisableSpecificRouting () shall raise the development error SOAD_E_INV_ARG .

At SoAd_IfSpecificRoutingGroupTransmit () SoAd shall store a trigger transmit request for each SoAdPduRouteDest that contains a refer- ence to the routing group identified by the parameter id for transmission on the socket connection identified by the parameter SoConId in the SoAd_MainFunction ().

For RoutingGroups that are referenced by a SoAdPduRout- eDest that refers to a SoAdSocketConnectionGroup SoAd shall maintain inde- pendent states for each SocketConnection that is part of the referenced SoAdSock- etConnectionGroup and handle them as if they were separate RoutingGroups.

SoAd shall handle SoAdPduRoute with SoAdPduRouteDest referring to a SoAdSocketConnectionGroup as if they were separate SoAdP- duRouteDest referring to each SocketConnection of this Group.

SoAd_Init () initializes all global variables of a Socket Adaptor instance and puts all socket connections into the state SOAD_SOCON_OFFLINE .

In case SoAd_GetSoConId () is called with a TxPduId related to a SoAdPduRoute with a fan-out (i.e. multiple SoAdPduRouteDest specified), SoAd_GetSoConId () shall skip further processings and return E_NOT_OK .

To trigger PDU data from an upper layer SoAd shall set PduIn- foType.SduDataPtr to the location of the buffer where the data shall be copied, set PduInfoType.SduDataLength to the length of this buffer and then call <Up> _[SoAd][If]TriggerTransmit ().

If SoAd_LocalIpAddrAssignmentChg () is called with the parameter IpAddrId set to a local address which is not referenced by any SoAd- SocketConnectionGroup , SoAd shall ignore the notification and return without any further action.

SoAd_TpChangeParameter () shall always reject requests by returning E_NOT_OK .

If SoAd_IfTransmit () was called with PduInfoPtr->Sdu- DataPtr set to NULL_PTR , SoAd shall use <Up>[SoAd][If]TriggerTransmit () to retrieve the PDU data from the upper layer.

SoAd shall only consider PduInfoPtr->SduDataPtr set to NULL_PTR as valid if SoAdIfTriggerTransmit is set to TRUE for the respective upper layer.

In case the nPdu feature is used for a socket connec- tion, the related PDU parameter SoAdTxPduCollectionSemantics is set to SOAD_COLLECT_LAST_IS_BEST and the upper layer doesn't provide all the re- quested data via <Up>[SoAd][If]TriggerTransmit () in the context of SoAd_- CopyTxData (), SoAd shall abort the transmission and return E_NOT_OK .

In case the nPdu feature is used for a socket connec- tion and all PDUs are configured with SoAdTxPduCollectionSemantics set to SOAD_COLLECT_LAST_IS_BEST , SoAd shall only transmit the last instance of each PDU with the same PduId in the sequence their first instances were requested for transmission.

SoAd shall reject configurations in which the transmit prop- erties (see SoAdTxPduCollectionSemantics ) of the PDUs which are as- signed to a socket connection are mixed. Furthermore all socket connnec- tions of a socket connection group shall either be refered solely by PDUs with SOAD_COLLECT_LAST_IS_BEST or solely by PDUs with SOAD_COLLECT_QUEUED semantic.

For all PDUs that have been stored for a socket connection using the nPdu feature, SoAd shall call the upper layer with the related transmit con- firmation function ( <Up>[SoAd][If]TxConfirmation ()) within the context of the SoAd_MainFunction () and with result set to 1. E_OK if the related TcpIp_UdpTransmit () call was successful, 2. E_NOT_OK if the transmission was not successful or cancelled for any other rea- son.

If development error detection is enabled: In case of a transmit request for a SoAdPduRoute that refers to a global PDU structure configured with a MetaDataItem of the type SOCKET_CONNECTION_ID_16 and the contained SoAd- PduRouteDest refers to a socket connection group, SoAd shall raise the develop- ment error SOAD_E_INV_METADATA , if the socket connection identified by PduInfo- Type.MetaDataPtr is not part of the socket connection group of the related SoAd- PduRouteDest .

In case of a transmit request for a SoAdPduRoute that refers to a global PDU structure configured with a MetaDataItem of the type SOCKET_CONNECTION_ID_16 and the contained SoAdPduRouteDest refers to a socket connection group, SoAd shall only perform the transmission on the socket connection identified by PduInfoType.MetaDataPtr instead of the whole group.

In case of a reception related to a SoAdSocketRouteDest, that refers to a global PDU structure configured with a MetaDataItem of the type SOCKET_CONNECTION_ID_16 , which is contained in a SoAdSocketRoute that refers to a socket connection group, SoAd shall use PduInfoType.MetaDataPtr to provide the socket connection identifier ( SoConId ) where the PDU was received with <Up>_[SoAd][If]RxIndication ().

Each time a socket connection state changes, SoAd shall no- tify the upper layer specified by SoAdSocketSoConModeChgNotifUpperLayerRef with the configured upper layer notification function <Up>_SoConModeChg () and the new state if the optional reference is set for the socket connection.

If a UDP socket connection is configured with a SoAdSock- etUdpAliveSupervisionTimeout and a datagram is received that passes the message acceptance filter, the timer shall be restarted with the value specified by the configuration parameter SoAdSocketUdpAliveSupervisionTimeout .

SoAd shall lock the remote address during the following situa- tions: 1. TCP socket connections not in state SOAD_SOCON_OFFLINE , 2. active receptions, 3. pending receptions of TP-PDUs, 4. active transmissions, 5. pending transmissions of the nPdu feature, 6. pending transmissions initiated via SoAd_IfRoutingGroupTransmit () or SoAd_IfSpecificRoutingGroupTransmit (). A locked remote address can't be modified by upper layers.

If development error detection is enabled and SoConId refers to a socket connection with configuration parameter SoAdSocketAutomaticSoCon- Setup set to TRUE , the function SoAd_ReleaseRemoteAddr () shall raise the devel- opment error SOAD_E_INV_ARG .

The function SoAd_ReleaseRemoteAddr () shall only imme- diately proceed if the SoConId refers to a socket connection which is not currently locked by the SoAd. If it is locked, the request shall be postponed to the SoAd_Main- Function () and executed once the lock is released.

The function SoAd_ReleaseRemoteAddr () shall reset the re- mote address of the socket connection referred by parameter SoConId to the config- ured remote address setting.

In case the nPdu feature is used for a socket connec- tion and the related PDU parameter SoAdTxPduCollectionSemantics is set to SOAD_COLLECT_LAST_IS_BEST , SoAd shall only store the transmission request in- stead of the PDU data. When SoAd needs to provide the PDU data, SoAd shall retrieve the data from the upper layer by calling <Up>[SoAd][If]TriggerTrans- mit ().

SoAd_GetAndResetMeasurementData () shall return mea- surement data for selected measurement index.

For measurement index SOAD_MEAS_DROP_TCP SoAd_- GetAndResetMeasurementData () shall return the number of dropped TCP-Port PDUs.

For measurement index SOAD_MEAS_DROP_UDP SoAd_- GetAndResetMeasurementData () shall return the number of dropped UDP-Port PDUs.

SoAd_GetAndResetMeasurementData () shall return E_NOT_OK if the requested measurement index is not supported.

SoAd_GetAndResetMeasurementData () shall additionally reset the measurement data to 0 if the MeasurementResetNeeded is true. The reset shall be applied after measurement data has been read.

SoAd_GetAndResetMeasurementData () shall reset all exist- ing measurement data to 0, if MeasurementResetNeeded is true and measurement index is set to SOAD_MEAS_ALL .

All measurement data which counts data shall not overrun.

SoAd_GetAndResetMeasurementData () shall accept Mea- surementDataPtr set to NULL_PTR . In this case the measurement data shall not be copied.

If development error detection is enabled: SoAd_GetAn- dResetMeasurementData () shall check that the service SoAd_Init () was previ- ously called. If the check fails, SoAd_GetAndResetMeasurementData () shall raise the development error SOAD_E_UNINIT .

The function SoAd_GetAndResetMeasurementData () shall be pre compile time configurable On/Off by the configuration parameter: SoAdGetAn- dResetMeasurementDataApi .

If the measurement data is enabled (see SoAdGetAndReset- MeasurementDataApi ), SoAd shall increment the corresponding measurement data whenever a received PDU is discarded.

Type of error Related error code Error value No buffer space available SOAD_E_NOBUFS 0x04 Unknown PduHeader ID SOAD_E_INV_PDUHEADER_ID 0x05 Automatic TCP connection failed SOAD_E_TCP_AUTOCONNECT_FAILED 0x10

For SoAdRoutingGroups that are referenced by a SoAdSock- etRouteDest that belongs to a SoAdSocketRoute referring to a SoAdSocketCon- nectionGroup , SoAd shall maintain independent states for each socket connection that is part of the referenced SoAdSocketConnectionGroup and handle them as if they were separate SoAdRoutingGroups.

If SoAd_EnableSpecificRouting () is called with SoConId belonging to a SoAdSocketConnectionGroup and for a SoAdRoutingGroup that is referenced by a SoAdSocketRouteDest that belongs to a SoAdSocketRoute referring to the same SoAdSocketConnectionGroup and that contains more than one SoAdSocketRouteDest , SoAd shall only enable the independent state for the socket connection if: 1. the same SoAdSocketRouteDest is not active for any other socket connection of the same SoAdSocketConnectionGroup (i.e. SoAdSocketRouteDest is not already mapped to another socket connection) and 2. no SoAdRoutingGroup is enabled on the socket connection which is referenced by another SoAdSocketRouteDest of the same SoAdSocketRoute (i.e. the socket connection is not mapped to another SoAdSocketRouteDest of the same SoAdSocketRoute ). Otherwise, E_NOT_OK shall be returned.

If the function SoAd_ReleaseRemoteAddr () resets the remote address of a socket connection to a configured remote address containing wildcards and socket connection is in mode SOAD_SOCON_ONLINE , SoAd shall change the mode of the socket connection to SOAD_SOCON_RECONNECT .

If security event reporting has been enabled for the SoAd module ( SoAdEnableSecurityEventReporting = true) the respective secu- rity events shall be reported to the IdsM via the interfaces defined in AU- TOSAR_SWS_BSWGeneral [2].

ID SOAD_SEV_DROP_PDU_RX_TCP SoAd dropped a PDU. The PDU violates stack configuration and was received via a TCP socket. 50 SOAD_SEV_DROP_PDU_RX_UDP SoAd dropped a PDU. The PDU violates stack configuration and was received via a UDP socket. 6 SOAD_SEV_DROP_MSG_RX_UDP_LENGTH SoAd dropped a message. The message contains at least one PDU which violates stack configuration and was received via a UDP socket. The violation relates to the length of the PDUs compared to the overall length of the message. 7 SOAD_SEV_DROP_MSG_RX_UDP_SOCKET SoAd received a UDP message which violates stack configuration and was dropped. No suitable socket connection matching to configuration was found. 8 SOAD_SEV_REJECTED_TCP_CONNECTION SoAd rejected a TCP connection. The connection request violates stack configuration. 9

If SoAdSocketTcpAutoConnectTimeout has been config- ured for that socket connection to a value > 0 SoAd shall repeat the invocation stated in [SWS_SoAd_00590] bullet (4) only for the time specified in SoAdSocketTcpAuto- ConnectTimeout .

If SoAdSocketTcpAutoConnectTimeout has elapsed for that socket connection and the socket connection has not yet reached SOAD_SOCON_ONLINE , then 1. the runtime error SOAD_E_TCP_AUTOCONNECT_FAILED shall be raised. 2. the socket connection shall close related TcpIp socket. 3. the socket connection shall be put into SOAD_SOCON_OFFLINE . 4. the socket connection shall stay in SOAD_SOCON_OFFLINE .

Each time a socket connection state changes, SoAd shall notify the BswM of the socket connection state change with the notification function BswM_- SoAd_SoConModeChg () and the new state if SoAdSocketSoConModeChgBswMNo- tification is set to TRUE for the socket connection.

If SoAd_IsConnectionReady () is called and the referred socket connection has no socket assigned, SoAd shall return TCPIP_E_NOT_OK .

If SoAd_IsConnectionReady () is called and the referred socket connection has a socket assigned, SoAd shall call TcpIp_IsConnection- Ready () to pass RemoteAddrPtr for the corresponding socket. The return value of TcpIp_IsConnectionReady () shall be forwarded to the caller.

If development error detection is enabled: SoAd_IsConnec- tionReady () shall check parameter SoConId for being valid. If the check fails, the function shall raise the development error SOAD_E_INV_ARG .

[SWS_SoAd_00771] ⌈In case PDU header option is enabled (SoAdPduHeaderEn- able is TRUE) for a TCP socket connection, SoAd shall convert the message into a PDU within SoAd_RxIndication() according to the following: 1. extract remaining PDU payload from the received TCP segment if the previous TCP segment contained fragmented PDU payload. If the end of the TCP segment is not reached continue with (3) 2. extract remaining PDU header from the received TCP segment if the previous TCP segment contained fragmented PDU header and continue with (4). 3. extract the PDU header from the received TCP segment. If the PDU header is fragmented over this and the next TCP segment, then store the received part of the PDU header and continue with (2) for the next TCP segment. 4. select the related socket route according to the received PDU Header ID (SoAd- RxPduHeaderId). If no socket route can be found, simply discard the PDU and raise the runtime error SOAD_E_INV_PDUHEADER_ID. 5. use the length field of the PDU header to identify the length of the actual PDU and the start of the next PDU to proceed with (3) until the end of the TCP fragment is reached. If at the end of the TCP segment the PDU header or payload is not completed, it shall be remembered for the next TCP segment. ⌋

[SWS_SoAd_00772] Status: DRAFT Upstream requirements: SRS_Eth_00163 ⌈If SoAdBswModuleRef is referencing Sd, then SoAd shall process incoming PDUs according to [SWS_SoAd_00773].⌋

[SWS_SoAd_00773].⌋

[SWS_SoAd_00774] Status: DRAFT Upstream requirements: SRS_Eth_00163 ⌈If Sd_RequestRoutingGroupEnable() returns E_OK, SoAd shall forward the Pdu data to the related upper layer.⌋ Note: Within Sd_RequestRoutingGroupEnable() Sd performs the ACL check. In case of success, it enables the corresponding routing group for faster processing of consecutive PDUs coming from the same remote node and it returns E_OK.

[SWS_SoAd_00775] Status: DRAFT Upstream requirements: SRS_Eth_00163 ⌈If Sd_RequestRoutingGroupEnable() returns E_NOT_OK, SoAd shall drop the received PDU.⌋ Note: Within Sd_RequestRoutingGroupEnable() Sd performs the ACL check. In case of failure, the corresponding routing group stays disabled and it returns E_NOT_OK.