StdLib/BsdSocketLib/listen.c

   1 /** @file
   2   Implement the listen API.
   3
   4   Copyright (c) 2011, Intel Corporation
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #include <SocketInternals.h>
  16
  17
  18 /**
  19   Establish the known port to listen for network connections.
  20
  21   The ::listen routine places the port into a state that enables connection
  22   attempts.  Connections are placed into FIFO order in a queue to be serviced
  23   by the application.  The application calls the ::accept routine to remove
  24   the next connection from the queue and get the associated socket.  The
  25   <a href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/listen.html">POSIX</a>
  26   documentation for the bind routine is available online for reference.
  27
  28   @param [in] s         Socket file descriptor returned from ::socket.
  29
  30   @param [in] backlog   backlog specifies the maximum FIFO depth for the connections
  31                         waiting for the application to call accept.  Connection attempts
  32                         received while the queue is full are refused.
  33
  34   @returns    The listen routine returns zero (0) if successful and -1 upon failure.
  35
  36  **/
  37 int
  38 listen (
  39   IN int s,
  40   IN int backlog
  41   )
  42 {
  43   int ListenStatus;
  44   EFI_SOCKET_PROTOCOL * pSocketProtocol;
  45   EFI_STATUS Status;
  46
  47   //
  48   //  Locate the context for this socket
  49   //
  50   pSocketProtocol = BslFdToSocketProtocol ( s, NULL, &errno );
  51   if ( NULL != pSocketProtocol ) {
  52     //
  53     //  Enable connections on the known port
  54     //
  55     Status = pSocketProtocol->pfnListen ( pSocketProtocol,
  56                                           backlog,
  57                                           &errno );
  58   }
  59
  60   //
  61   //  Return the operation stauts
  62   //
  63   ListenStatus = ( 0 == errno ) ? 0 : -1;
  64   return ListenStatus;
  65 }