]> git.proxmox.com Git - mirror_edk2.git/blob - StdLib/BsdSocketLib/poll.c
Fix @return Doxygen commands to be singular instead of plural.
[mirror_edk2.git] / StdLib / BsdSocketLib / poll.c
1 /** @file
2 Implement the poll 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 Poll the socket for activity
20
21 @param [in] pDescriptor Descriptor address for the file
22
23 @param [in] Events Mask of events to detect
24
25 @return Detected events for the socket
26
27 **/
28 short
29 BslSocketPoll (
30 IN struct __filedes * pDescriptor,
31 IN short Events
32 )
33 {
34 short DetectedEvents;
35 EFI_SOCKET_PROTOCOL * pSocketProtocol;
36 EFI_STATUS Status;
37
38 //
39 // Locate the socket protocol
40 //
41 DetectedEvents = 0;
42 pSocketProtocol = BslValidateSocketFd ( pDescriptor, &errno );
43 if ( NULL != pSocketProtocol ) {
44 //
45 // Poll the socket
46 //
47 Status = pSocketProtocol->pfnPoll ( pSocketProtocol,
48 Events,
49 &DetectedEvents,
50 &errno );
51 }
52
53 //
54 // Return the detected events
55 //
56 return DetectedEvents;
57 }