]> git.proxmox.com Git - mirror_edk2.git/blob - StdLib/BsdSocketLib/send.c
Fix @return Doxygen commands to be singular instead of plural.
[mirror_edk2.git] / StdLib / BsdSocketLib / send.c
1 /** @file
2 Implement the send 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 Send data using a network connection.
20
21 The ::send routine queues data to the network for transmission.
22 The
23 <a href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/send.html">POSIX</a>
24 documentation is available online.
25
26 @param [in] s Socket file descriptor returned from ::socket.
27
28 @param [in] buffer Address of a buffer containing the data to send.
29
30 @param [in] length Length of the buffer in bytes.
31
32 @param [in] flags Message control flags
33
34 @return ::send returns the number of data bytes that were
35 sent and -1 when an error occurs. In the case of
36 an error, errno contains more details.
37
38 **/
39 ssize_t
40 send (
41 int s,
42 CONST void * buffer,
43 size_t length,
44 int flags
45 )
46 {
47 //
48 // Send the data
49 //
50 return sendto ( s, buffer, length, flags, NULL, 0 );
51 }