4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TCP4 protocol services header file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2005 - 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncare licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncwhich accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Driver Produced Protocol Prototypes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Function prototype for the Tcp4 socket request handler
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The procotol handler provided to the socket layer, used to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync dispatch the socket level requests by calling the corresponding
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TCP layer functions.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Sock Pointer to the socket of this TCP instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Request The code of this operation request.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Data Pointer to the operation specific data passed in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync together with the operation request.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The socket request is completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval other The error status returned by the corresponding TCP
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync layer function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// TCP mode data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// TCP route infomation data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Get the current operational status of a TCP instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The GetModeData() function copies the current operational settings of this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI TCPv4 Protocol instance into user-supplied buffers. This function can
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync also be used to retrieve the operational setting of underlying drivers
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync such as IPv4, MNP, or SNP.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Pointer to the EFI_TCP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Tcp4State Pointer to the buffer to receive the current TCP
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Tcp4ConfigData Pointer to the buffer to receive the current TCP
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configuration.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Ip4ModeData Pointer to the buffer to receive the current IPv4
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configuration data used by the TCPv4 instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MnpConfigData Pointer to the buffer to receive the current MNP
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configuration data indirectly used by the TCPv4
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SnpModeData Pointer to the buffer to receive the current SNP
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configuration data indirectly used by the TCPv4
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The mode data was read.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED No configuration data is available because this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync instance hasn't been started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Initialize or brutally reset the operational parameters for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this EFI TCPv4 instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Configure() function does the following:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Initialize this EFI TCPv4 instance, i.e., initialize the communication end
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync setting, specify active open or passive open for an instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Reset this TCPv4 instance brutally, i.e., cancel all pending asynchronous
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync tokens, flush transmission and receiving buffer directly without informing
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the communication peer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync No other TCPv4 Protocol operation can be executed by this instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync until it is configured properly. For an active TCP4 instance, after a proper
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configuration it may call Connect() to initiates the three-way handshake.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync For a passive TCP4 instance, its state will transit to Tcp4StateListen after
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configuration, and Accept() may be called to listen the incoming TCP connection
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync request. If TcpConfigData is set to NULL, the instance is reset. Resetting
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync process will be done brutally, the state machine will be set to Tcp4StateClosed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync directly, the receive queue and transmit queue will be flushed, and no traffic is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync allowed through this instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Pointer to the EFI_TCP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param TcpConfigData Pointer to the configure data to configure the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The operational settings are set, changed, or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync reset successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING When using a default address, configuration
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (through DHCP, BOOTP, RARP, etc.) is not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED Configuring TCP instance when it is already
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configured.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR An unexpected network or system error occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED One or more of the control options are not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync supported in the implementation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Could not allocate enough system resources.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Add or delete routing entries.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Routes() function adds or deletes a route from the instance's routing table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The most specific route is selected by comparing the SubnetAddress with the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync destination IP address's arithmetical AND to the SubnetMask.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The default route is added with both SubnetAddress and SubnetMask set to 0.0.0.0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The default route matches all destination IP addresses if there is no more specific route.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Direct route is added with GatewayAddress set to 0.0.0.0. Packets are sent to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the destination host if its address can be found in the Address Resolution Protocol (ARP)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync cache or it is on the local subnet. If the instance is configured to use default
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync address, a direct route to the local network will be added automatically.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Each TCP instance has its own independent routing table. Instance that uses the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync default IP address will have a copy of the EFI_IP4_CONFIG_PROTOCOL's routing table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The copy will be updated automatically whenever the IP driver reconfigures its
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync instance. As a result, the previous modification to the instance's local copy
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will be lost. The priority of checking the route table is specific with IP
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync implementation and every IP implementation must comply with RFC 1122.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Pointer to the EFI_TCP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DeleteRoute If TRUE, delete the specified route from routing
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync table; if FALSE, add the specified route to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync routing table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DestinationAddress and SubnetMask are used as
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the keywords to search route entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SubnetAddress The destination network.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SubnetMask The subnet mask for the destination network.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param GatewayAddress The gateway address for this route.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync It must be on the same subnet with the station
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync address unless a direct route is specified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The operation completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The EFI_TCP4_PROTOCOL instance has not been
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configured.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING When using a default address, configuration
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (through DHCP, BOOTP, RARP, etc.) is not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Could not allocate enough resources to add the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync entry to the routing table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND This route is not in the routing table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED This route is already in the routing table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The TCP driver does not support this operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Initiate a nonblocking TCP connection request for an active TCP instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Connect() function will initiate an active open to the remote peer configured
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in current TCP instance if it is configured active. If the connection succeeds
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync or fails due to any error, the ConnectionToken->CompletionToken.Event will be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync signaled and ConnectionToken->CompletionToken.Status will be updated accordingly.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function can only be called for the TCP instance in Tcp4StateClosed state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The instance will transfer into Tcp4StateSynSent if the function returns EFI_SUCCESS.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If TCP three way handshake succeeds, its state will become Tcp4StateEstablished,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync otherwise, the state will return to Tcp4StateClosed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Pointer to the EFI_TCP4_PROTOCOL instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ConnectionToken Pointer to the connection token to return when
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the TCP three way handshake finishes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The connection request is successfully initiated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and the state of this TCPv4 instance has
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync been changed to Tcp4StateSynSent.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED This EFI_TCP4_PROTOCOL instance hasn't been
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configured.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The instance is not configured as an active one
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync or it is not in Tcp4StateClosed state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The driver can't allocate enough resource to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync initiate the active open.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Listen on the passive instance to accept an incoming connection request.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Accept() function initiates an asynchronous accept request to wait for an
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync incoming connection on the passive TCP instance. If a remote peer successfully
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync establishes a connection with this instance, a new TCP instance will be created
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and its handle will be returned in ListenToken->NewChildHandle. The newly created
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync instance is configured by inheriting the passive instance's configuration and is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ready for use upon return. The instance is in the Tcp4StateEstablished state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The ListenToken->CompletionToken.Event will be signaled when a new connection
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is accepted, user aborts the listen or connection is reset. This function only
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync can be called when current TCP instance is in Tcp4StateListen state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Pointer to the EFI_TCP4_PROTOCOL instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ListenToken Pointer to the listen token to return when
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync operation finishes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The listen token has been queued successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The EFI_TCP4_PROTOCOL instance hasn't been
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configured.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The instatnce is not a passive one or it is not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in Tcp4StateListen state or a same listen token
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync has already existed in the listen token queue of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this TCP instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Could not allocate enough resources to finish
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR Any unexpected and not belonged to above category error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Queues outgoing data into the transmit queue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Transmit() function queues a sending request to this TCPv4 instance along
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync with the user data. The status of the token is updated and the event in the token
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will be signaled once the data is sent out or some error occurs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Pointer to the EFI_TCP4_PROTOCOL instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Token Pointer to the completion token to queue to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync transmit queue
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The data has been queued for transmission.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The EFI_TCP4_PROTOCOL instance hasn't been
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configured.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING When using a default address, configuration
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (DHCP, BOOTP, RARP, etc.) is not finished yet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED One or more of the following conditions is TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * A transmit completion token with the same
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Token-> CompletionToken.Event was already in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync transmission queue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * The current instance is in Tcp4StateClosed state
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * The current instance is a passive one and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync it is in Tcp4StateListen state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * User has called Close() to disconnect this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync connection.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY The completion token could not be queued because
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the transmit queue is full.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Could not queue the transmit data because of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync resource shortage.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NETWORK_UNREACHABLE There is no route to the destination network or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Place an asynchronous receive request into the receiving queue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Receive() function places a completion token into the receive packet queue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is always asynchronous. The caller must allocate the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Token->CompletionToken.Event and the FragmentBuffer used to receive data. He also
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync must fill the DataLength which represents the whole length of all FragmentBuffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync When the receive operation completes, the EFI TCPv4 Protocol driver updates the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Token->CompletionToken.Status and Token->Packet.RxData fields and the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Token->CompletionToken.Event is signaled. If got data the data and its length
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will be copy into the FragmentTable, in the same time the full length of received
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync data will be recorded in the DataLength fields. Providing a proper notification
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync function and context for the event will enable the user to receive the notification
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and receiving status. That notification function is guaranteed to not be re-entered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Pointer to the EFI_TCP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Token Pointer to a token that is associated with the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync receive data descriptor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The receive completion token was cached.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The EFI_TCP4_PROTOCOL instance hasn't been
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configured.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING When using a default address, configuration
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (DHCP, BOOTP, RARP, etc.) is not finished yet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync due to a lack of system resources.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The EFI TCPv4 Protocol instance has been reset
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to startup defaults.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED One or more of the following conditions is TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * A receive completion token with the same
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Token->CompletionToken.Event was already in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the receive queue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * The current instance is in Tcp4StateClosed state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * The current instance is a passive one and it
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is in Tcp4StateListen state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * User has called Close() to disconnect this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync connection.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_CONNECTION_FIN The communication peer has closed the connection
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and there is no any buffered data in the receive
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync buffer of this instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY The receive request could not be queued because
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the receive queue is full.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Disconnecting a TCP connection gracefully or reset a TCP connection.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Initiate an asynchronous close token to TCP driver. After Close() is called,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync any buffered transmission data will be sent by TCP driver and the current
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync instance will have a graceful close working flow described as RFC 793 if
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AbortOnClose is set to FALSE, otherwise, a rest packet will be sent by TCP
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync driver to fast disconnect this connection. When the close operation completes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync successfully the TCP instance is in Tcp4StateClosed state, all pending
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync asynchronous operation is signaled and any buffers used for TCP network traffic
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is flushed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Pointer to the EFI_TCP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CloseToken Pointer to the close token to return when
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync operation finishes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The operation completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The EFI_TCP4_PROTOCOL instance hasn't been
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configured.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED One or more of the following are TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Configure() has been called with TcpConfigData
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync set to NULL and this function has not returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Previous Close() call on this instance has not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One ore more parameters are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Could not allocate enough resource to finish the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR Any unexpected and not belonged to above
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync category error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Abort an asynchronous connection, listen, transmission or receive request.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Cancel() function aborts a pending connection, listen, transmit or receive
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync request. If Token is not NULL and the token is in the connection, listen,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync transmission or receive queue when it is being cancelled, its Token->Status
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will be set to EFI_ABORTED and then Token->Event will be signaled. If the token
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is not in one of the queues, which usually means that the asynchronous operation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync has completed, EFI_NOT_FOUND is returned. If Token is NULL all asynchronous token
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync issued by Connect(), Accept(), Transmit() and Receive()will be aborted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NOTE: It has not been implemented currently.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Pointer to the EFI_TCP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Token Pointer to a token that has been issued by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Connect(), Accept(), Transmit() or Receive(). If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NULL, all pending tokens issued by above four
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync functions will be aborted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The asynchronous I/O request is aborted and Token->Event
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is signaled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED This instance hasn's been configured.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING When using the default address, configuration
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (DHCP, BOOTP,RARP, etc.) hasn's finished yet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The asynchronous I/O request isn's found in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync transmission or receive queue. It has either
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync completed or wasn's issued by Transmit() and Receive().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The operation is not supported in current
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync implementation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Poll to receive incoming data and transmit outgoing segments.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Poll() function increases the rate that data is moved between the network
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and application and can be called when the TCP instance is created successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Its use is optional. In some implementations, the periodical timer in the MNP
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync driver may not poll the underlying communications device fast enough to avoid
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync drop packets. Drivers and applications that are experiencing packet loss should
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync try calling the Poll() function in a high frequency.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Pointer to the EFI_TCP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Incoming or outgoing data was processed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY No incoming or outgoing data was processed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TIMEOUT Data was dropped out of the transmission or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync receive queue. Consider increasing the polling