vpr::SocketDatagramImplNSPR Class Reference

NSPR implementation of the datagram socket interface. More...

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

Inheritance diagram for vpr::SocketDatagramImplNSPR:

[legend]Collaboration diagram for vpr::SocketDatagramImplNSPR:

[legend]List of all members.

Public Types
typedef SocketImplNSPR	Parent
Public Member Functions
	SocketDatagramImplNSPR ()
	Default constructor.
	SocketDatagramImplNSPR (const InetAddr &localAddr, const InetAddr &remoteAddr)
	Constructor.
	SocketDatagramImplNSPR (const SocketDatagramImplNSPR &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)
vpr::ReturnStatus	sendto (const void *msg, const vpr::Uint32 length, const vpr::InetAddr &to, vpr::Uint32 &bytesSent, const vpr::Interval timeout=vpr::Interval::NoTimeout)

---

Detailed Description

NSPR implementation of the datagram socket interface.

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

Definition at line 59 of file SocketDatagramImplNSPR.h.

---

Member Typedef Documentation

typedef SocketImplNSPR vpr::SocketDatagramImplNSPR::Parent

Definition at line 62 of file SocketDatagramImplNSPR.h.

---

Constructor & Destructor Documentation

vpr::SocketDatagramImplNSPR::SocketDatagramImplNSPR

(

)

[inline]

Default constructor.

Postcondition:

The member variables are initialized to default values. The socket type is set to vpr::SocketTypes::DATAGRAM.

Definition at line 74 of file SocketDatagramImplNSPR.h.

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

vpr::SocketDatagramImplNSPR::SocketDatagramImplNSPR	(	const InetAddr &	localAddr,
		const InetAddr &	remoteAddr
	)			[inline]

Constructor.

Postcondition:

The member variables are initialized to default values. The socket type is set to vpr::SocketTypes::DATAGRAM.

Parameters:

	localAddr	The local address to which this socket will be bound.
	remoteAddr	The remote address whith which this socket will communicate.

Definition at line 89 of file SocketDatagramImplNSPR.h.

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

vpr::SocketDatagramImplNSPR::SocketDatagramImplNSPR

(

const SocketDatagramImplNSPR &

sock

)

[inline]

Copy constructor.

Definition at line 97 of file SocketDatagramImplNSPR.h.

References vpr::SocketImplNSPR::mLocalAddr, and vpr::SocketImplNSPR::mRemoteAddr.

      : SocketImplNSPR(sock)
   {
      mLocalAddr  = sock.mLocalAddr;
      mRemoteAddr = sock.mRemoteAddr;
   }

---

Member Function Documentation

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

Definition at line 61 of file SocketDatagramImplNSPR.cpp.

References vpr::ReturnStatus::ConnectionAborted, vpr::ReturnStatus::Fail, vpr::SocketImplNSPR::mHandle, vpr::ReturnStatus::NotConnected, vpr::NSPR_getInterval(), vpr::ErrorImplPosix::outputCurrentError(), vpr::ReturnStatus::setCode(), vpr::ReturnStatus::Timeout, vprDBG_ALL(), vprDBG_CRITICAL_LVL, vprDEBUG, vprDEBUG_FLUSH, and vpr::ReturnStatus::WouldBlock.

{
   ReturnStatus retval;
   PRInt32 bytes;

   bytes = PR_RecvFrom(mHandle, msg, length, 0, from.getPRNetAddr(),
                       NSPR_getInterval(timeout));

   if ( bytes > 0 )
   {
      bytesRead = bytes;
   }
   else if ( bytes == -1 )
   {
      const PRErrorCode err_code = PR_GetError();

      bytesRead = 0;

      if ( err_code == PR_WOULD_BLOCK_ERROR )
      {
         retval.setCode(vpr::ReturnStatus::WouldBlock);
      }
      else if ( err_code == PR_IO_TIMEOUT_ERROR )
      {
#if defined(WINNT)
         // Handle the case of a timeout error on an NT socket. We have to
         // tell NSPR to put the socket back into the right state. We do not
         // need to worry about whether the socket is blocking because the
         // timeout is ignored by non-blocking NSPR sockets.
         PR_NT_CancelIo(mHandle);
#endif
         retval.setCode(ReturnStatus::Timeout);
      }
      else if ( err_code == PR_CONNECT_ABORTED_ERROR )
      {
         retval.setCode(vpr::ReturnStatus::ConnectionAborted);
      }
      else
      {
         std::ostringstream err_stream;
         vpr::Error::outputCurrentError(err_stream,
                                        "Could not read from socket");
         vprDEBUG(vprDBG_ALL, vprDBG_CRITICAL_LVL)
            << "[vpr::SocketDatagramImplNSPR::recvfrom()] "
            << err_stream.str() << std::endl << vprDEBUG_FLUSH;
         retval.setCode(ReturnStatus::Fail);
      }
   }
   else if ( bytes == 0 )      // Not connected
   {
      retval.setCode(ReturnStatus::NotConnected);
      bytesRead = bytes;
   }

   return retval;
}

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

Definition at line 122 of file SocketDatagramImplNSPR.cpp.

References vpr::InetAddrBSD::AnyAddr, vpr::ReturnStatus::ConnectionAborted, vpr::ReturnStatus::Fail, vpr::SocketImplNSPR::mHandle, vpr::ReturnStatus::NotConnected, vpr::NSPR_getInterval(), vpr::ErrorImplPosix::outputCurrentError(), vpr::ReturnStatus::setCode(), vpr::ReturnStatus::Timeout, vprASSERT, vprDBG_ALL(), vprDBG_CRITICAL_LVL, vprDEBUG, vprDEBUG_FLUSH, and vpr::ReturnStatus::WouldBlock.

{
   ReturnStatus retval;
   PRInt32 bytes;

#ifdef VPR_OS_Win32
   vprASSERT(vpr::InetAddr::AnyAddr != to && "INADDR_ANY is not a valid desination on win32.");
#endif

   bytes = PR_SendTo(mHandle, msg, length, 0, to.getPRNetAddr(),
                     NSPR_getInterval(timeout));

   if ( bytes == -1 )
   {
      const PRErrorCode err_code = PR_GetError();

      bytesSent = 0;

      if ( err_code == PR_WOULD_BLOCK_ERROR )
      {
         retval.setCode(vpr::ReturnStatus::WouldBlock);
      }
      else if ( err_code == PR_IO_TIMEOUT_ERROR )
      {
#if defined(WINNT)
         // Handle the case of a timeout error on an NT socket. We have to
         // tell NSPR to put the socket back into the right state. We do not
         // need to worry about whether the socket is blocking because the
         // timeout is ignored by non-blocking NSPR sockets.
         PR_NT_CancelIo(mHandle);
#endif
         retval.setCode(ReturnStatus::Timeout);
      }
      else if ( err_code == PR_CONNECT_ABORTED_ERROR )
      {
         retval.setCode(vpr::ReturnStatus::ConnectionAborted);
      }
      else if ( err_code == PR_NOT_CONNECTED_ERROR )
      {
         retval.setCode(vpr::ReturnStatus::NotConnected);
      }
      else
      {
         std::ostringstream err_stream;
         vpr::Error::outputCurrentError(err_stream, "Could not send message");
         vprDEBUG(vprDBG_ALL, vprDBG_CRITICAL_LVL)
            << "[vpr::SocketDatagramImplNSPR::sendto()] " << err_stream.str()
            << std::endl << vprDEBUG_FLUSH;
         retval.setCode(ReturnStatus::Fail);
      }
   }
   else
   {
      bytesSent = bytes;
   }

   return retval;
}

---

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

• SocketDatagramImplNSPR.h
• SocketDatagramImplNSPR.cpp

---