summaryrefslogtreecommitdiff
path: root/StdLib/BsdSocketLib
diff options
context:
space:
mode:
Diffstat (limited to 'StdLib/BsdSocketLib')
-rw-r--r--StdLib/BsdSocketLib/SocketInternals.h14
-rw-r--r--StdLib/BsdSocketLib/accept.c6
-rw-r--r--StdLib/BsdSocketLib/bind.c8
-rw-r--r--StdLib/BsdSocketLib/close.c8
-rw-r--r--StdLib/BsdSocketLib/connect.c8
-rw-r--r--StdLib/BsdSocketLib/getpeername.c2
-rw-r--r--StdLib/BsdSocketLib/getsockname.c2
-rw-r--r--StdLib/BsdSocketLib/listen.c2
-rw-r--r--StdLib/BsdSocketLib/poll.c2
-rw-r--r--StdLib/BsdSocketLib/read.c2
-rw-r--r--StdLib/BsdSocketLib/recv.c6
-rw-r--r--StdLib/BsdSocketLib/recvfrom.c4
-rw-r--r--StdLib/BsdSocketLib/send.c4
-rw-r--r--StdLib/BsdSocketLib/sendto.c4
-rw-r--r--StdLib/BsdSocketLib/shutdown.c4
-rw-r--r--StdLib/BsdSocketLib/socket.c10
-rw-r--r--StdLib/BsdSocketLib/write.c2
17 files changed, 44 insertions, 44 deletions
diff --git a/StdLib/BsdSocketLib/SocketInternals.h b/StdLib/BsdSocketLib/SocketInternals.h
index 4f5c584a4e..8fbd8420dc 100644
--- a/StdLib/BsdSocketLib/SocketInternals.h
+++ b/StdLib/BsdSocketLib/SocketInternals.h
@@ -57,7 +57,7 @@
address for the file
@param [in] pErrno Address of the errno variable
- @returns A pointer to the socket protocol structure or NULL if
+ @return A pointer to the socket protocol structure or NULL if
an invalid file descriptor was passed in.
**/
@@ -73,7 +73,7 @@ BslFdToSocketProtocol (
@param [in] pDescriptor Descriptor address for the file
- @returns This routine returns 0 upon success and -1 upon failure.
+ @return This routine returns 0 upon success and -1 upon failure.
In the case of failure, errno contains more information.
**/
@@ -105,7 +105,7 @@ BslSocketCloseWork (
@param [in] Events Mask of events to detect
- @returns Detected events for the socket
+ @return Detected events for the socket
**/
short
@@ -121,7 +121,7 @@ BslSocketPoll (
@param [in] pErrno Address of the errno variable
- @returns The file descriptor for the socket or -1 if an error occurs.
+ @return The file descriptor for the socket or -1 if an error occurs.
**/
int
@@ -138,7 +138,7 @@ BslSocketProtocolToFd (
@param [in] LengthInBytes Number of bytes to read
@param [in] pBuffer Address of the buffer to receive the data
- @returns The number of bytes read or -1 if an error occurs.
+ @return The number of bytes read or -1 if an error occurs.
**/
ssize_t
@@ -157,7 +157,7 @@ BslSocketRead (
@param [in] LengthInBytes Number of bytes to write
@param [in] pBuffer Address of the data
- @returns The number of bytes written or -1 if an error occurs.
+ @return The number of bytes written or -1 if an error occurs.
**/
ssize_t
@@ -175,7 +175,7 @@ BslSocketWrite (
@param [in] pErrno Address of the errno variable
- @returns A pointer to the socket protocol structure or NULL if
+ @return A pointer to the socket protocol structure or NULL if
an invalid file descriptor was passed in.
**/
diff --git a/StdLib/BsdSocketLib/accept.c b/StdLib/BsdSocketLib/accept.c
index de8d91f607..25ae1b5861 100644
--- a/StdLib/BsdSocketLib/accept.c
+++ b/StdLib/BsdSocketLib/accept.c
@@ -27,7 +27,7 @@
of the remote network address buffer. Upon return,
contains the length of the remote network address.
- @returns ::accept returns zero if successful and -1 when an error occurs.
+ @return ::accept returns zero if successful and -1 when an error occurs.
In the case of an error, errno contains more details.
**/
@@ -108,7 +108,7 @@ AcceptWork (
of the remote network address buffer. Upon return,
contains the length of the remote network address.
- @returns ::accept returns zero if successful and -1 when an error occurs.
+ @return ::accept returns zero if successful and -1 when an error occurs.
In the case of an error, errno contains more details.
**/
@@ -139,7 +139,7 @@ accept (
of the remote network address buffer. Upon return,
contains the length of the remote network address.
- @returns This routine returns zero if successful and -1 when an error occurs.
+ @return This routine returns zero if successful and -1 when an error occurs.
In the case of an error, errno contains more details.
**/
diff --git a/StdLib/BsdSocketLib/bind.c b/StdLib/BsdSocketLib/bind.c
index fc24ea420a..c1bf64e9e4 100644
--- a/StdLib/BsdSocketLib/bind.c
+++ b/StdLib/BsdSocketLib/bind.c
@@ -22,9 +22,9 @@
<a href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/bind.html">POSIX</a>
documentation for the bind routine is available online for reference.
- @param [in] s Socket file descriptor returned from ::socket.
+ @param[in] s Socket file descriptor returned from ::socket.
- @param [in] name Address of a sockaddr structure that contains the
+ @param[in] name Address of a sockaddr structure that contains the
connection point on the local machine. An IPv4 address
of INADDR_ANY specifies that the connection is made to
all of the network stacks on the platform. Specifying a
@@ -34,9 +34,9 @@
number from the dynamic range. Specifying a specific
port number causes the network layer to use that port.
- @param [in] namelen Specifies the length in bytes of the sockaddr structure.
+ @param[in] namelen Specifies the length in bytes of the sockaddr structure.
- @returns The bind routine returns zero (0) if successful and -1 upon failure.
+ @return The bind routine returns zero (0) if successful and -1 upon failure.
**/
int
diff --git a/StdLib/BsdSocketLib/close.c b/StdLib/BsdSocketLib/close.c
index 7d70e4f126..2a9fda4930 100644
--- a/StdLib/BsdSocketLib/close.c
+++ b/StdLib/BsdSocketLib/close.c
@@ -18,9 +18,9 @@
/**
Worker routine to close the socket.
- @param [in] pSocketProtocol Socket protocol structure address
+ @param[in] pSocketProtocol Socket protocol structure address
- @param [in] pErrno Address of the errno variable
+ @param[in] pErrno Address of the errno variable
@retval EFI_SUCCESS Successfully closed the socket
@@ -83,9 +83,9 @@ BslSocketCloseWork (
/**
Close the socket
- @param [in] pDescriptor Descriptor address for the file
+ @param[in] pDescriptor Descriptor address for the file
- @returns This routine returns 0 upon success and -1 upon failure.
+ @return This routine returns 0 upon success and -1 upon failure.
In the case of failure, errno contains more information.
**/
diff --git a/StdLib/BsdSocketLib/connect.c b/StdLib/BsdSocketLib/connect.c
index e02762efa3..92fc75bdb0 100644
--- a/StdLib/BsdSocketLib/connect.c
+++ b/StdLib/BsdSocketLib/connect.c
@@ -42,10 +42,10 @@
@param [in] s Socket file descriptor returned from ::socket.
@param [in] address Network address of the remote system
-
+
@param [in] address_len Length of the remote network address
- @returns ::connect returns zero if successful and -1 when an error occurs.
+ @return ::connect returns zero if successful and -1 when an error occurs.
In the case of an error, errno contains more details.
**/
@@ -61,7 +61,7 @@ connect (
struct __filedes * pDescriptor;
EFI_SOCKET_PROTOCOL * pSocketProtocol;
EFI_STATUS Status;
-
+
//
// Locate the context for this socket
//
@@ -85,7 +85,7 @@ connect (
&errno );
} while ( bBlocking && ( EFI_NOT_READY == Status ));
}
-
+
//
// Return the new socket file descriptor
//
diff --git a/StdLib/BsdSocketLib/getpeername.c b/StdLib/BsdSocketLib/getpeername.c
index 850308a401..37e6d1eab6 100644
--- a/StdLib/BsdSocketLib/getpeername.c
+++ b/StdLib/BsdSocketLib/getpeername.c
@@ -29,7 +29,7 @@
@param [in] address_len Length of the remote network address structure
- @returns ::getpeername returns zero (0) if successful or -1 when an error occurs.
+ @return ::getpeername returns zero (0) if successful or -1 when an error occurs.
In the case of an error, errno contains more details.
**/
diff --git a/StdLib/BsdSocketLib/getsockname.c b/StdLib/BsdSocketLib/getsockname.c
index 0b72edcf29..e8d1d55bb3 100644
--- a/StdLib/BsdSocketLib/getsockname.c
+++ b/StdLib/BsdSocketLib/getsockname.c
@@ -29,7 +29,7 @@
@param [in] address_len Length of the local network address structure
- @returns ::getsockname returns zero (0) if successful or -1 when an error occurs.
+ @return ::getsockname returns zero (0) if successful or -1 when an error occurs.
In the case of an error, errno contains more details.
**/
diff --git a/StdLib/BsdSocketLib/listen.c b/StdLib/BsdSocketLib/listen.c
index 5e14876652..193444a25c 100644
--- a/StdLib/BsdSocketLib/listen.c
+++ b/StdLib/BsdSocketLib/listen.c
@@ -31,7 +31,7 @@
waiting for the application to call accept. Connection attempts
received while the queue is full are refused.
- @returns The listen routine returns zero (0) if successful and -1 upon failure.
+ @return The listen routine returns zero (0) if successful and -1 upon failure.
**/
int
diff --git a/StdLib/BsdSocketLib/poll.c b/StdLib/BsdSocketLib/poll.c
index fdf50e8b68..336924d556 100644
--- a/StdLib/BsdSocketLib/poll.c
+++ b/StdLib/BsdSocketLib/poll.c
@@ -22,7 +22,7 @@
@param [in] Events Mask of events to detect
- @returns Detected events for the socket
+ @return Detected events for the socket
**/
short
diff --git a/StdLib/BsdSocketLib/read.c b/StdLib/BsdSocketLib/read.c
index eb72f5cbf7..6f8d42974b 100644
--- a/StdLib/BsdSocketLib/read.c
+++ b/StdLib/BsdSocketLib/read.c
@@ -23,7 +23,7 @@
@param [in] LengthInBytes Number of bytes to read
@param [in] pBuffer Address of the buffer to receive the data
- @returns The number of bytes read or -1 if an error occurs.
+ @return The number of bytes read or -1 if an error occurs.
**/
ssize_t
diff --git a/StdLib/BsdSocketLib/recv.c b/StdLib/BsdSocketLib/recv.c
index 735e1dbddd..91f07cb08a 100644
--- a/StdLib/BsdSocketLib/recv.c
+++ b/StdLib/BsdSocketLib/recv.c
@@ -26,12 +26,12 @@
@param [in] s Socket file descriptor returned from ::socket.
@param [in] buffer Address of a buffer to receive the data.
-
+
@param [in] length Length of the buffer in bytes.
@param [in] flags Message control flags
- @returns ::recv returns the number of valid bytes in the buffer,
+ @return ::recv returns the number of valid bytes in the buffer,
zero if no data was received, and -1 when an error occurs.
In the case of an error, errno contains more details.
@@ -45,7 +45,7 @@ recv (
)
{
ssize_t BytesRead;
-
+
//
// Receive the data from the remote system
//
diff --git a/StdLib/BsdSocketLib/recvfrom.c b/StdLib/BsdSocketLib/recvfrom.c
index a8d1ab54ee..ce230231dc 100644
--- a/StdLib/BsdSocketLib/recvfrom.c
+++ b/StdLib/BsdSocketLib/recvfrom.c
@@ -26,7 +26,7 @@
@param [in] s Socket file descriptor returned from ::socket.
@param [in] buffer Address of a buffer to receive the data.
-
+
@param [in] length Length of the buffer in bytes.
@param [in] flags Message control flags
@@ -35,7 +35,7 @@
@param [in] address_len Length of the remote network address structure
- @returns ::recvfrom returns the number of valid bytes in the buffer,
+ @return ::recvfrom returns the number of valid bytes in the buffer,
zero if no data was received, and -1 when an error occurs.
In the case of an error, errno contains more details.
diff --git a/StdLib/BsdSocketLib/send.c b/StdLib/BsdSocketLib/send.c
index f3f739cb6f..0bbed5ac33 100644
--- a/StdLib/BsdSocketLib/send.c
+++ b/StdLib/BsdSocketLib/send.c
@@ -26,12 +26,12 @@
@param [in] s Socket file descriptor returned from ::socket.
@param [in] buffer Address of a buffer containing the data to send.
-
+
@param [in] length Length of the buffer in bytes.
@param [in] flags Message control flags
- @returns ::send returns the number of data bytes that were
+ @return ::send returns the number of data bytes that were
sent and -1 when an error occurs. In the case of
an error, errno contains more details.
diff --git a/StdLib/BsdSocketLib/sendto.c b/StdLib/BsdSocketLib/sendto.c
index aa6ea8c14a..5311ce6022 100644
--- a/StdLib/BsdSocketLib/sendto.c
+++ b/StdLib/BsdSocketLib/sendto.c
@@ -26,7 +26,7 @@
@param [in] s Socket file descriptor returned from ::socket.
@param [in] buffer Address of a buffer containing the data to send.
-
+
@param [in] length Length of the buffer in bytes.
@param [in] flags Message control flags
@@ -35,7 +35,7 @@
@param [in] tolen Length of remote system address structure
- @returns ::send returns the number of data bytes that were
+ @return ::send returns the number of data bytes that were
sent and -1 when an error occurs. In the case of
an error, errno contains more details.
diff --git a/StdLib/BsdSocketLib/shutdown.c b/StdLib/BsdSocketLib/shutdown.c
index 4c00feade7..c3df1ee519 100644
--- a/StdLib/BsdSocketLib/shutdown.c
+++ b/StdLib/BsdSocketLib/shutdown.c
@@ -26,8 +26,8 @@
@param [in] s Socket file descriptor returned from ::socket.
@param [in] how Which operations to shutdown
-
- @returns ::shutdown returns the zero (0) if successful or -1 when an
+
+ @return ::shutdown returns the zero (0) if successful or -1 when an
error occurs. In the latter case, errno contains more details.
**/
diff --git a/StdLib/BsdSocketLib/socket.c b/StdLib/BsdSocketLib/socket.c
index 3754a29eb0..e78329291c 100644
--- a/StdLib/BsdSocketLib/socket.c
+++ b/StdLib/BsdSocketLib/socket.c
@@ -47,7 +47,7 @@ const struct fileops SocketOperations = {
address for the file
@param [in] pErrno Address of the errno variable
- @returns A pointer to the socket protocol structure or NULL if
+ @return A pointer to the socket protocol structure or NULL if
an invalid file descriptor was passed in.
**/
@@ -101,10 +101,10 @@ BslFdToSocketProtocol (
Build a file descriptor for a socket.
@param [in] pSocketProtocol Socket protocol structure address
-
+
@param [in] pErrno Address of the errno variable
- @returns The file descriptor for the socket or -1 if an error occurs.
+ @return The file descriptor for the socket or -1 if an error occurs.
**/
int
@@ -194,7 +194,7 @@ BslSocketProtocolToFd (
<li>IPPROTO_UDP</li> - This value must be combined with SOCK_DGRAM.</li>
</ul>
- @returns This routine returns a file descriptor for the socket.
+ @return This routine returns a file descriptor for the socket.
**/
INT32
@@ -250,7 +250,7 @@ socket (
@param [in] pErrno Address of the errno variable
- @returns A pointer to the socket protocol structure or NULL if
+ @return A pointer to the socket protocol structure or NULL if
an invalid file descriptor was passed in.
**/
diff --git a/StdLib/BsdSocketLib/write.c b/StdLib/BsdSocketLib/write.c
index d04dda9c39..f6f50006af 100644
--- a/StdLib/BsdSocketLib/write.c
+++ b/StdLib/BsdSocketLib/write.c
@@ -23,7 +23,7 @@
@param [in] LengthInBytes Number of bytes to write
@param [in] pBuffer Address of the data
- @returns The number of bytes written or -1 if an error occurs.
+ @return The number of bytes written or -1 if an error occurs.
**/
ssize_t
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-06 07:45:29 +0000