SNIP_CLASSIC_TCPIP_SECTION_8_7_3_3_SocketOwner_functions

8.7.3.3 SocketOwner functions [SWS_TcpIp_00220] Upstream requirements: SRS_Eth_00103 ⌈For sockets related to a TcpIpSocketOwner with TcpIpSocketOwnerUpperLayerType set to ’SOAD’, TcpIp shall replace the tag <Up> with ’SoAd’ for each of the following configurable interfaces.⌋ [SWS_TcpIp_00221] Upstream requirements: SRS_Eth_00103 ⌈For sockets related to a TcpIpSocketOwner with TcpIpSocketOwnerUpperLayerType set to ’CDD’, TcpIp shall use the configured API names for each of the following configurable interfaces.⌋ 8.7.3.3.1 <Up_RxIndication> [SWS_TCPIP_00223] Definition of configurable interface <Up_RxIndication> Upstream requirements: SRS_Eth_00103 ⌈ Service Name <Up_RxIndication> Syntax void <Up_RxIndication> ( TcpIp_SocketIdType SocketId, const TcpIp_SockAddrType* RemoteAddrPtr, const uint8* BufPtr, uint16 Length ) Sync/Async Synchronous Reentrancy Reentrant for different SocketIds. Non reentrant for the same SocketId. SocketId Socket identifier of the related local socket resource. RemoteAddrPtr Pointer to memory containing IP address and port of the remote host which sent the data. BufPtr Pointer to the received data. Parameters (in) Length Data length of the received TCP segment or UDP datagram. Parameters (inout) None Parameters (out) None Return value None Description 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. Available via SoAd.h if the respective TcpIpSocketOwnerUpperLayerType is SOAD, otherwise TcpIpSocket OwnerHeaderFileName ⌋ 8.7.3.3.2 <Up_TcpIpEvent> [SWS_TCPIP_00224] Definition of configurable interface <Up_TcpIpEvent> Upstream requirements: SRS_Eth_00103 ⌈ Service Name <Up_TcpIpEvent> Syntax void <Up_TcpIpEvent> ( TcpIp_SocketIdType SocketId, TcpIp_EventType Event ) Sync/Async Synchronous Reentrancy Non Reentrant SocketId Socket identifier of the related local socket resource. Parameters (in) Event This parameter contains a description 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. Available via SoAd.h if the respective TcpIpSocketOwnerUpperLayerType is SOAD, otherwise TcpIpSocket OwnerHeaderFileName ⌋ 8.7.3.3.3 <Up_TxConfirmation> [SWS_TCPIP_00225] Definition of configurable interface <Up_TxConfirmation> Upstream requirements: SRS_Eth_00103 ⌈ Service Name <Up_TxConfirmation> Syntax void <Up_TxConfirmation> ( TcpIp_SocketIdType SocketId, uint16 Length ) Sync/Async Synchronous Reentrancy Reentrant for different SocketIds. Non reentrant for the same SocketId. SocketId Socket identifier of the related local socket resource. Parameters (in) Length Number of transmitted data bytes. Parameters (inout) None Parameters (out) None Return value None Description 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. Available via SoAd.h if the respective TcpIpSocketOwnerUpperLayerType is SOAD, otherwise TcpIpSocket OwnerHeaderFileName ⌋ 8.7.3.3.4 <Up_TcpAccepted> [SWS_TCPIP_00226] Definition of configurable interface <Up_TcpAccepted> Upstream requirements: SRS_Eth_00103 ⌈ Service Name <Up_TcpAccepted> Syntax Std_ReturnType <Up_TcpAccepted> ( TcpIp_SocketIdType SocketId, TcpIp_SocketIdType SocketIdConnected, const TcpIp_SockAddrType* RemoteAddrPtr ) Sync/Async Synchronous Reentrancy Non Reentrant ▽ △ SocketId Socket identifier of the related local socket resource which has been used at TcpIp_Bind() SocketIdConnected Socket identifier of the local socket resource used for the established connection. Parameters (in) RemoteAddrPtr IP address and port of the remote host. Parameters (inout) None Parameters (out) None Return value Std_ReturnType Result of operation E_OK upper layer accepts the established connection E_NOT_OK upper layer refuses the established connection, TcpIp stack shall close the connection. Description 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. Available via SoAd.h if the respective TcpIpSocketOwnerUpperLayerType is SOAD, otherwise TcpIpSocket OwnerHeaderFileName ⌋ 8.7.3.3.5 <Up_TcpConnected> [SWS_TCPIP_00227] Definition of configurable interface <Up_TcpConnected> Upstream requirements: SRS_Eth_00103 ⌈ Service Name <Up_TcpConnected> Syntax void <Up_TcpConnected> ( TcpIp_SocketIdType SocketId ) Sync/Async Synchronous Reentrancy Non Reentrant Parameters (in) SocketId Socket identifier of the related local socket resource. Parameters (inout) None Parameters (out) None Return value None Description 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. Available via SoAd.h if the respective TcpIpSocketOwnerUpperLayerType is SOAD, otherwise TcpIpSocket OwnerHeaderFileName ⌋