Fix @return Doxygen commands to be singular instead of plural.

[mirror_edk2.git] / StdLib / BsdSocketLib / close.c

/** @file\r
  Implement the close API.\r
\r
  Copyright (c) 2011, Intel Corporation\r
  All rights reserved. This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include <SocketInternals.h>\r
\r
\r
/**\r
  Worker routine to close the socket.\r
\r
  @param[in] pSocketProtocol   Socket protocol structure address\r
\r
  @param[in] pErrno            Address of the errno variable\r
\r
  @retval EFI_SUCCESS   Successfully closed the socket\r
\r
**/\r
EFI_STATUS\r
BslSocketCloseWork (\r
  IN EFI_SOCKET_PROTOCOL * pSocketProtocol,\r
  IN int * pErrno\r
  )\r
{\r
  EFI_SERVICE_BINDING_PROTOCOL * pServiceBinding;\r
  EFI_STATUS Status;\r
\r
  //\r
  //  Start closing the socket\r
  //\r
  Status = pSocketProtocol->pfnCloseStart ( pSocketProtocol,\r
                                            FALSE,\r
                                            pErrno );\r
\r
  //\r
  //  Wait for the socket to close or an error\r
  //\r
  while ( EFI_NOT_READY == Status ) {\r
    Status = pSocketProtocol->pfnClosePoll ( pSocketProtocol,\r
                                             pErrno );\r
  }\r
  if ( !EFI_ERROR ( Status )) {\r
    //\r
    //  Locate the socket protocol\r
    //\r
    Status = gBS->LocateProtocol ( &gEfiSocketServiceBindingProtocolGuid,\r
                                   NULL,\r
                                   (VOID **) &pServiceBinding );\r
    if ( !EFI_ERROR ( Status )) {\r
      //\r
      //  Release the handle\r
      //\r
      Status = pServiceBinding->DestroyChild ( pServiceBinding,\r
                                               pSocketProtocol->SocketHandle );\r
    }\r
    if ( EFI_ERROR ( Status )) {\r
      *pErrno = EIO;\r
    }\r
  }\r
  else {\r
    DEBUG (( DEBUG_ERROR,\r
              "ERROR - Failed to close the socket: %r\r\n",\r
              Status ));\r
    *pErrno = EIO;\r
  }\r
\r
  //\r
  //  Return the close status\r
  //\r
  return Status;\r
}\r
\r
\r
/**\r
  Close the socket\r
\r
  @param[in] pDescriptor Descriptor address for the file\r
\r
  @return   This routine returns 0 upon success and -1 upon failure.\r
            In the case of failure, errno contains more information.\r
\r
**/\r
int\r
BslSocketClose (\r
  struct __filedes * pDescriptor\r
  )\r
{\r
  int CloseStatus;\r
  EFI_SOCKET_PROTOCOL * pSocketProtocol;\r
\r
  //\r
  //  Locate the socket protocol\r
  //\r
  pSocketProtocol = BslValidateSocketFd ( pDescriptor, &errno );\r
  if ( NULL != pSocketProtocol ) {\r
    //\r
    //  Close the socket\r
    //\r
    BslSocketCloseWork ( pSocketProtocol, &errno );\r
  }\r
\r
  //\r
  //  Return the close status\r
  //\r
  CloseStatus = ( errno == 0 ) ? 0 : -1;\r
  return CloseStatus;\r
}\r