vpr::SocketDatagramImplBSD Class Reference

Implementation class for datagram sockets using the BSD sockets interface. More...

#include <vpr/IO/Socket/SocketDatagram.h>

Inheritance diagram for vpr::SocketDatagramImplBSD:

[legend]Collaboration diagram for vpr::SocketDatagramImplBSD:

[legend]List of all members.

Public Types
typedef SocketImplBSD	Parent
Public Member Functions
	SocketDatagramImplBSD ()
	Default constructor.
	SocketDatagramImplBSD (const InetAddr &localAddr, const InetAddr &remoteAddr)
	Constructs a datagram socket using the given addresses as defaults for communication channels.
	SocketDatagramImplBSD (const SocketDatagramImplBSD &sock)
	Copy constructor.
vpr::ReturnStatus	recvfrom (void *msg, const vpr::Uint32 length, vpr::InetAddr &from, vpr::Uint32 &bytesRead, const vpr::Interval timeout=vpr::Interval::NoTimeout)
	Receives a message from the specified address.
vpr::ReturnStatus	sendto (const void *msg, const vpr::Uint32 length, const vpr::InetAddr &to, vpr::Uint32 &bytesSent, const vpr::Interval timeout=vpr::Interval::NoTimeout)
	Sends a message to the specified address.

---

Detailed Description

Implementation class for datagram sockets using the BSD sockets interface.

This is used in conjunction with vpr::SocketConfiguration to create the BSD implementation of the typedef vpr::SocketDatagram.

Definition at line 61 of file SocketDatagramImplBSD.h.

---

Member Typedef Documentation

typedef SocketImplBSD vpr::SocketDatagramImplBSD::Parent

Definition at line 64 of file SocketDatagramImplBSD.h.

---

Constructor & Destructor Documentation

vpr::SocketDatagramImplBSD::SocketDatagramImplBSD

(

)

Default constructor.

This sets the socket type to vpr::SocketTypes::DATAGRAM.

Definition at line 63 of file SocketDatagramImplBSD.cpp.

   : SocketImplBSD(vpr::SocketTypes::DATAGRAM)
{
   /* Do nothing. */ ;
}

vpr::SocketDatagramImplBSD::SocketDatagramImplBSD	(	const InetAddr &	localAddr,
		const InetAddr &	remoteAddr
	)

Constructs a datagram socket using the given addresses as defaults for communication channels.

Postcondition:

The member variables are initialized with the type in particular set to vpr::SocketTypes::DATAGRAM.

Parameters:

	localAddr	The local address for this socket. This is used for binding the socket.
	remoteAddr	The remote address for this socket. This is used to specify a default destination for all packets.

Definition at line 69 of file SocketDatagramImplBSD.cpp.

   : SocketImplBSD(localAddr, remoteAddr, vpr::SocketTypes::DATAGRAM)
{
   /* Do nothing. */ ;
}

vpr::SocketDatagramImplBSD::SocketDatagramImplBSD

(

const SocketDatagramImplBSD &

sock

)

Copy constructor.

Postcondition:

This socket is a copy of the given socket.

Definition at line 76 of file SocketDatagramImplBSD.cpp.

References vpr::FileHandleImplUNIX::getName(), vpr::FileHandleImplUNIX::mBlocking, vpr::FileHandleImplUNIX::mFdesc, vpr::SocketImplBSD::mHandle, and vpr::FileHandleImplUNIX::mOpen.

   : SocketImplBSD(sock.mLocalAddr, sock.mRemoteAddr, SocketTypes::DATAGRAM)
{
   mHandle            = new FileHandleImplUNIX(sock.mHandle->getName());
   mHandle->mFdesc    = sock.mHandle->mFdesc;
   mHandle->mOpen     = sock.mHandle->mOpen;
   mHandle->mBlocking = sock.mHandle->mBlocking;
}

---

Member Function Documentation

vpr::ReturnStatus vpr::SocketDatagramImplBSD::recvfrom	(	void *	msg,
		const vpr::Uint32	length,
		vpr::InetAddr &	from,
		vpr::Uint32 &	bytesRead,
		const vpr::Interval	timeout = vpr::Interval::NoTimeout
	)

Receives a message from the specified address.

Definition at line 85 of file SocketDatagramImplBSD.cpp.

References errno, vpr::ReturnStatus::Fail, vpr::InetAddrBSD::getAddressString(), vpr::InetAddrBSD::getPort(), vpr::SocketImplBSD::isBlocking(), vpr::FileHandleImplUNIX::isReadable(), vpr::InetAddrBSD::mAddr, vpr::SocketImplBSD::mBlockingFixed, vpr::FileHandleImplUNIX::mFdesc, vpr::SocketImplBSD::mHandle, vpr::SocketImplBSD::mRemoteAddr, vpr::ReturnStatus::NotConnected, vpr::ReturnStatus::setCode(), vpr::InetAddrBSD::size(), vpr::ReturnStatus::success(), and vpr::ReturnStatus::WouldBlock.

{
#if defined(VPR_OS_IRIX) || defined(VPR_OS_HPUX)
   int fromlen;
#else
   socklen_t fromlen;
#endif

   vpr::ReturnStatus retval;

   retval = mHandle->isReadable(timeout);

   if ( retval.success() )
   {
      ssize_t bytes;

      mBlockingFixed = true;

      fromlen = from.size();
      bytes   = ::recvfrom(mHandle->mFdesc, msg, length, 0,
                           (struct sockaddr*) &from.mAddr, &fromlen);

      if ( bytes == -1 )
      {
         bytesRead = 0;

         if ( errno == EAGAIN && ! isBlocking() )
         {
            retval.setCode(vpr::ReturnStatus::WouldBlock);
         }
         else
         {
            fprintf(stderr,
                    "[vpr::SocketDatagramImplBSD] ERROR: Could not read from socket (%s:%hu): %s\n",
                    mRemoteAddr.getAddressString().c_str(),
                    mRemoteAddr.getPort(), strerror(errno));
            retval.setCode(vpr::ReturnStatus::Fail);
         }
      }
      else if ( bytes == 0 )
      {
         retval.setCode(vpr::ReturnStatus::NotConnected);
      }
      else
      {
         bytesRead = bytes;
      }
   }

   return retval;
}

vpr::ReturnStatus vpr::SocketDatagramImplBSD::sendto	(	const void *	msg,
		const vpr::Uint32	length,
		const vpr::InetAddr &	to,
		vpr::Uint32 &	bytesSent,
		const vpr::Interval	timeout = vpr::Interval::NoTimeout
	)

Sends a message to the specified address.

Definition at line 141 of file SocketDatagramImplBSD.cpp.

References errno, vpr::ReturnStatus::Fail, vpr::InetAddrBSD::getAddressString(), vpr::InetAddrBSD::getPort(), vpr::SocketImplBSD::isBlocking(), vpr::FileHandleImplUNIX::isWriteable(), vpr::InetAddrBSD::mAddr, vpr::SocketImplBSD::mBlockingFixed, vpr::FileHandleImplUNIX::mFdesc, vpr::SocketImplBSD::mHandle, vpr::SocketImplBSD::mRemoteAddr, vpr::ReturnStatus::NotConnected, vpr::ReturnStatus::setCode(), vpr::InetAddrBSD::size(), vpr::ReturnStatus::success(), and vpr::ReturnStatus::WouldBlock.

{
   vpr::ReturnStatus retval;

   retval = mHandle->isWriteable(timeout);

   if ( retval.success() )
   {
      ssize_t bytes;

      mBlockingFixed = true;

      bytes = ::sendto(mHandle->mFdesc, msg, length, 0,
                       (struct sockaddr*) &to.mAddr, to.size());

      if ( bytes == -1 )
      {
         bytesSent = 0;

         if ( errno == EAGAIN && ! isBlocking() )
         {
            retval.setCode(vpr::ReturnStatus::WouldBlock);
         }
         else
         {
            fprintf(stderr,
                    "[vpr::SocketDatagramImplBSD] ERROR: Could not send to %s:%hu on socket (%s:%hu): %s\n",
                    to.getAddressString().c_str(), to.getPort(),
                    mRemoteAddr.getAddressString().c_str(),
                    mRemoteAddr.getPort(), strerror(errno));
            retval.setCode(vpr::ReturnStatus::Fail);
         }
      }
      else if ( errno == EHOSTUNREACH || errno == EHOSTDOWN ||
                errno == ENETDOWN )
      {
         retval.setCode(vpr::ReturnStatus::NotConnected);
      }
      else
      {
         bytesSent = bytes;
      }
   }

   return retval;
}

---

The documentation for this class was generated from the following files:

• SocketDatagramImplBSD.h
• SocketDatagramImplBSD.cpp

---