4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/** @file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Implement the read API.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2011, Intel Corporation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync All rights reserved. This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync http://opensource.org/licenses/bsd-license.php
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <SocketInternals.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Read support routine for sockets
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The BslSocketRead routine is called indirectly by the read file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync system routine. This routine is typically used for SOCK_STREAM
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync because it waits for receive data from the target system specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in the ::connect call.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param [in] pDescriptor Descriptor address for the file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param [in] pOffset File offset
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param [in] LengthInBytes Number of bytes to read
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param [in] pBuffer Address of the buffer to receive the data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The number of bytes read or -1 if an error occurs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync In the case of an error, ::errno contains more details.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncssize_t
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncBslSocketRead (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync struct __filedes *pDescriptor,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync off_t * pOffset,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync size_t LengthInBytes,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync void * pBuffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ssize_t BytesRead;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Receive the data from the remote system
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BytesRead = recvfrom ( pDescriptor->MyFD,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync pBuffer,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync LengthInBytes,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NULL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NULL );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Return the number of bytes read
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return BytesRead;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}