]>
git.proxmox.com Git - mirror_edk2.git/blob - NetworkPkg/TcpDxe/SockImpl.h
2 The function declaration that provided for Socket Interface.
4 Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php.
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
22 Signal a event with the given status.
24 @param[in] Token The token's event is to be signaled.
25 @param[in] TokenStatus The status to be sent with the event.
28 #define SIGNAL_TOKEN(Token, TokenStatus) \
30 (Token)->Status = (TokenStatus); \
31 gBS->SignalEvent ((Token)->Event); \
34 #define SOCK_HEADER_SPACE (60 + 60 + 72)
37 Process the TCP send data, buffer the tcp txdata and append
38 the buffer to socket send buffer, then try to send it.
40 @param[in] Sock Pointer to the socket.
41 @param[in] TcpTxData Pointer to the application provided send buffer.
43 @retval EFI_SUCCESS The operation completed successfully.
44 @retval EFI_OUT_OF_RESOURCES Failed due to resource limits.
48 SockProcessTcpSndData (
54 Get received data from the socket layer to the receive token.
56 @param[in, out] Sock Pointer to the socket.
57 @param[in, out] RcvToken Pointer to the application provided receive token.
59 @return The length of data received in this token.
65 IN OUT SOCK_IO_TOKEN
*RcvToken
69 Flush the sndBuffer and rcvBuffer of socket.
71 @param[in, out] Sock Pointer to the socket.
80 Cancel the tokens in the specific token list.
82 @param[in] Token Pointer to the Token. If NULL, all tokens
83 in SpecifiedTokenList will be canceled.
84 @param[in, out] SpecifiedTokenList Pointer to the token list to be checked.
86 @retval EFI_SUCCESS Cancel the tokens in the specific token listsuccessfully.
87 @retval EFI_NOT_FOUND The Token is not found in SpecifiedTokenList.
92 IN SOCK_COMPLETION_TOKEN
*Token
,
93 IN OUT LIST_ENTRY
*SpecifiedTokenList
97 Create a socket with initial data SockInitData.
99 @param[in] SockInitData Pointer to the initial data of the socket.
101 @return Pointer to the newly created socket, return NULL when exception occured.
106 IN SOCK_INIT_DATA
*SockInitData
112 @param[in, out] Sock Pointer to the socket.