vpr::SocketDatagramImplSIM Class Reference

Implementation of datagram sockets using simulated sockets. More...

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

Inheritance diagram for vpr::SocketDatagramImplSIM:

[legend]Collaboration diagram for vpr::SocketDatagramImplSIM:

[legend]List of all members.

Public Member Functions
	SocketDatagramImplSIM ()
	Default constructor.
	SocketDatagramImplSIM (const vpr::InetAddr &localAddr, const vpr::InetAddr &remoteAddr)
	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)
virtual vpr::ReturnStatus	isReadReady () const
	Tests if this socket can read without blocking.
virtual vpr::ReturnStatus	isWriteReady () const
	Tests if this socket can write without blocking.

---

Detailed Description

Implementation of datagram sockets using simulated sockets.

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

Definition at line 60 of file SocketDatagramImplSIM.h.

---

Constructor & Destructor Documentation

vpr::SocketDatagramImplSIM::SocketDatagramImplSIM

(

)

[inline]

Default constructor.

Postcondition:

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

Definition at line 69 of file SocketDatagramImplSIM.h.

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

vpr::SocketDatagramImplSIM::SocketDatagramImplSIM	(	const vpr::InetAddr &	localAddr,
		const vpr::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 85 of file SocketDatagramImplSIM.h.

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

---

Member Function Documentation

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

Definition at line 55 of file SocketDatagramImplSIM.cpp.

References vpr::SocketImplSIM::mArrivedQueue, vpr::SocketImplSIM::mArrivedQueueMutex, vpr::SocketImplSIM::mBound, vpr::ReturnStatus::setCode(), vprASSERT, and vpr::ReturnStatus::WouldBlock.

{
   vpr::ReturnStatus status;
   vprASSERT(mBound && "Can recvfrom if we are not bound so they can send to us");

   vpr::Guard<vpr::Mutex> guard(mArrivedQueueMutex);

   if ( ! mArrivedQueue.empty() )
   {
      vpr::sim::MessagePtr msg_ptr = mArrivedQueue.front();
      vpr::Uint32 msg_size, copy_len;

      msg_size = msg_ptr->getSize();

      // Use the smaller of length and msg_size for the actual amount of
      // data to copy.
      copy_len = (length > msg_size) ? msg_size : length;

      // Complete the read operation.
      memcpy(msg, msg_ptr->getBody(), copy_len);
      bytes_read = copy_len;

      from = msg_ptr->getSourceSocket()->getLocalAddr();

      if ( msg_ptr->resize(copy_len) == 0 )
      {
         mArrivedQueue.pop_front();
      }
   }
   else
   {
      status.setCode(vpr::ReturnStatus::WouldBlock);
      bytes_read = 0;
   }

   return status;
}

vpr::ReturnStatus vpr::SocketDatagramImplSIM::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 97 of file SocketDatagramImplSIM.cpp.

References vpr::SocketImplSIM::bind(), vpr::sim::Controller::instance(), vpr::SocketImplSIM::mBound, vpr::sim::SocketManager::sendMessageTo(), and vprASSERT.

{
   vpr::ReturnStatus status;
   vpr::sim::SocketManager& sock_mgr =
      vpr::sim::Controller::instance()->getSocketManager();

   if ( ! mBound )
   {
      bind();      
   }

   vprASSERT( mBound && "Must be bound before sending");

   bytes_sent = length;
   vpr::sim::MessagePtr net_msg(new vpr::sim::Message(msg, length));
   sock_mgr.sendMessageTo(net_msg, this, to);

   return status;
}

vpr::ReturnStatus vpr::SocketDatagramImplSIM::isReadReady

(

)

const [virtual]

Tests if this socket can read without blocking.

Postcondition:

Depending on the state of the socket, the caller is informed if a read will block or not.

Returns:

vpr::ReturnStatus::Succeed is returned if this socket can read without blocking. That is, there is data waiting to be read from its arrival queue.

vpr::ReturnStatus::Timeout is returned if this socket did not become ready for reading within the timeout period.

vpr::ReturnStatus::Fail is returned if this socket is not ready for reading. This can happen if the socket is not open, not connected, or without any received data.

Implements vpr::SocketImplSIM.

Definition at line 121 of file SocketDatagramImplSIM.cpp.

References vpr::ReturnStatus::Fail, vpr::SocketImplSIM::mArrivedQueue, vpr::SocketImplSIM::mOpen, and vpr::ReturnStatus::setCode().

{
   vpr::ReturnStatus status;

   if ( ! mOpen || mArrivedQueue.empty() )
   {
      status.setCode(vpr::ReturnStatus::Fail);
   }

   return status;
}

vpr::ReturnStatus vpr::SocketDatagramImplSIM::isWriteReady

(

)

const [virtual]

Tests if this socket can write without blocking.

Postcondition:

Depending on the state of the socket, the caller is informed if a write will succeed or not.

Returns:

vpr::ReturnStatus::Succeed is returned if this socket can write without blocking. That is, this socket is in a connected state, and data can be sent to its peer right away.

vpr::ReturnStatus::Timeout is returned if this socket did not become ready for writing within the timeout period.

vpr::ReturnStatus::Fail is returned if this socket is not ready for writing. This can happen if the socket is not open or not connected.

Implements vpr::SocketImplSIM.

Definition at line 133 of file SocketDatagramImplSIM.cpp.

References vpr::ReturnStatus::Fail, vpr::SocketImplSIM::mOpen, and vpr::ReturnStatus::setCode().

{
   vpr::ReturnStatus status;

   if ( ! mOpen )
   {
      status.setCode(vpr::ReturnStatus::Fail);
   }

   return status;
}

---

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

• SocketDatagramImplSIM.h
• SocketDatagramImplSIM.cpp

---