vpr::sim::NetworkNode Class Reference

This class must be default constrible, assignable, and copy constructible. More...

#include <vpr/md/SIM/Network/NetworkNode.h>

Collaboration diagram for vpr::sim::NetworkNode:

[legend]List of all members.

Public Member Functions
	NetworkNode ()
	NetworkNode (const vpr::Uint32 index, const vpr::Uint8 type, const std::string &ip_str)
	Constructs a new network node using the given paramters.
	~NetworkNode ()
void	addSocket (vpr::SocketImplSIM *sock)
vpr::ReturnStatus	removeSocket (const vpr::SocketImplSIM *sock)
bool	hasSocket (const vpr::Uint32 port, const vpr::SocketTypes::Type type)
	Checks to see if this node currently has a socket of the given type in use on the named port.
vpr::SocketImplSIM *	getSocket (const vpr::Uint32 port, const vpr::SocketTypes::Type type)
const vpr::Uint32 &	getIndex () const
void	setIndex (const vpr::Uint32 index)
const vpr::Uint8 &	getType () const
void	setType (const vpr::Uint8 type)
const vpr::Uint32 &	getIpAddress () const
	Retrieves the 32-bit IPv4 address for this network node.
const std::string &	getIpAddressString () const
vpr::Uint32	getUnassignedTcpPortNumber ()
	Get an unused TCP port number.
vpr::Uint32	getUnassignedUdpPortNumber ()
	Get an unused UDP port number.

---

Detailed Description

This class must be default constrible, assignable, and copy constructible.

Definition at line 71 of file NetworkNode.h.

---

Constructor & Destructor Documentation

vpr::sim::NetworkNode::NetworkNode

(

)

[inline]

Definition at line 74 of file NetworkNode.h.

      : mIndex(0)
      , mType(0)
      , mIpAddr(0)
   {
      /* Do nothing. */ ;
   }

vpr::sim::NetworkNode::NetworkNode	(	const vpr::Uint32	index,
		const vpr::Uint8	type,
		const std::string &	ip_str
	)

Constructs a new network node using the given paramters.

This will parse the given IP address (it must be a standard IPv4 dotted-decimal string) and create the corresponding integer address.

Definition at line 63 of file NetworkNode.cpp.

References vpr::SystemPosix::Ntohl().

   : mIndex(index), mType(type), mIpStr(ip_str), mIpAddr(0)
{
   std::string::size_type cur_pos, next_dot;
   std::string cur_val;

   union
   {
      char bytes[4];
      vpr::Uint32 value;
   } ip_addr;

   cur_pos = 0;

   for ( vpr::Uint8 i = 0; i < 4; ++i )
   {
      next_dot = ip_str.find(".", cur_pos);
      cur_val  = ip_str.substr(cur_pos, next_dot - cur_pos);

      ip_addr.bytes[i] = atoi(cur_val.c_str());

      cur_pos = next_dot + 1;
   }

   mIpAddr = vpr::System::Ntohl(ip_addr.value);
}

vpr::sim::NetworkNode::~NetworkNode

(

)

[inline]

Definition at line 90 of file NetworkNode.h.

   {
      /* Do nothing. */ ;
   }

---

Member Function Documentation

void vpr::sim::NetworkNode::addSocket

(

vpr::SocketImplSIM *

sock

)

Definition at line 137 of file NetworkNode.cpp.

References vpr::SocketTypes::DATAGRAM, vpr::InetAddrBSD::getAddressValue(), vpr::SocketImplSIM::getLocalAddr(), vpr::InetAddrBSD::getPort(), vpr::SocketImplSIM::getType(), hasSocket(), vpr::SocketTypes::STREAM, vprASSERT, vprDBG_ALL(), vprDBG_CRITICAL_LVL, vprDBG_STATE_LVL, vprDEBUG, and vprDEBUG_FLUSH.

{
   vpr::Uint32 port = sock->getLocalAddr().getPort();
   vprASSERT( mIpAddr == sock->getLocalAddr().getAddressValue() && "Trying to add socket to node of wrong ip addr");
   if(hasSocket(port, sock->getType()))
      vprDEBUG(vprDBG_ALL, vprDBG_CRITICAL_LVL) << "NetworkNode::addSocket: Tried to overwrite existing socket: " << sock->getLocalAddr() << std::endl << vprDEBUG_FLUSH;
   vprASSERT(! hasSocket(port, sock->getType()) && "Tried to overwrite an existing socket");

   vprDEBUG(vprDBG_ALL, vprDBG_STATE_LVL)
      << "NetworkNode::addSocket() [" << mIpStr << "]: Adding socket (" << sock
      << ") with local address " << sock->getLocalAddr() << " to node "
      << mIpStr << "\n" << vprDEBUG_FLUSH;

   switch (sock->getType())
   {
      case vpr::SocketTypes::DATAGRAM:
         {
            //vpr::Guard<vpr::Mutex> guard(mDgramMapMutex);
            vprASSERT( dynamic_cast<vpr::SocketDatagramImplSIM*>(sock) != NULL);
            mDgramSocketMap[port] = sock;
         }
         break;
      case vpr::SocketTypes::STREAM:
         {
            //vpr::Guard<vpr::Mutex> guard(mStreamMapMutex);
            vprASSERT( dynamic_cast<vpr::SocketStreamImplSIM*>(sock) != NULL);
            mStreamSocketMap[port] = sock;
         }
         break;
   }
}

vpr::ReturnStatus vpr::sim::NetworkNode::removeSocket

(

const vpr::SocketImplSIM *

sock

)

Definition at line 169 of file NetworkNode.cpp.

References vpr::SocketTypes::DATAGRAM, vpr::ReturnStatus::Fail, vpr::InetAddrBSD::getAddressValue(), vpr::SocketImplSIM::getLocalAddr(), vpr::InetAddrBSD::getPort(), vpr::SocketImplSIM::getType(), hasSocket(), vpr::ReturnStatus::setCode(), vpr::SocketTypes::STREAM, vpr::ReturnStatus::Succeed, vprASSERT, vprDBG_ALL(), vprDBG_STATE_LVL, vprDBG_VERB_LVL, vprDEBUG, and vprDEBUG_FLUSH.

{
   vpr::ReturnStatus status(vpr::ReturnStatus::Fail);
   socket_map_t::iterator i;

   vpr::Uint32 port( sock->getLocalAddr().getPort() );
   vpr::Uint32 ip_addr( sock->getLocalAddr().getAddressValue() );

   vprASSERT( hasSocket(port, sock->getType())  && "Trying to remove a socket that isn't registered with node");
   vprASSERT( mIpAddr == ip_addr && "Removing socket from wrong node [ip addresses differ]");

   vprDEBUG(vprDBG_ALL, vprDBG_STATE_LVL)
      << "NetworkNode::removeSocket() [" << mIpStr
      << "]: Removing socket bound to " << sock->getLocalAddr() << "\n"
      << vprDEBUG_FLUSH;

   switch (sock->getType())
   {
      case vpr::SocketTypes::DATAGRAM:
         {
            //vpr::Guard<vpr::Mutex> guard(mDgramMapMutex);
            i = mDgramSocketMap.find(port);

            if ( i != mDgramSocketMap.end() )
            {
               mDgramSocketMap.erase(i);
               status.setCode(vpr::ReturnStatus::Succeed);
               vprDEBUG(vprDBG_ALL, vprDBG_VERB_LVL) << "NetworkNode::removeSocket() [" << mIpStr
                                                     << "]: Removed datagram socket\n" << vprDEBUG_FLUSH;
               vprASSERT(!hasSocket(port, sock->getType()) && "Erasing did nothing");
            }
         }
         break;
      case vpr::SocketTypes::STREAM:
         {
            //vpr::Guard<vpr::Mutex> guard(mStreamMapMutex);
         
            i = mStreamSocketMap.find(port);
   
            if ( i != mStreamSocketMap.end() )
            {
               mStreamSocketMap.erase(i);
               status.setCode(vpr::ReturnStatus::Succeed);
               vprDEBUG(vprDBG_ALL, vprDBG_VERB_LVL) << "NetworkNode::removeSocket() [" << mIpStr
                                                     << "]: Removed stream socket\n" << vprDEBUG_FLUSH;
               vprASSERT(!hasSocket(port, sock->getType()) && "Erasing did nothing");
            }
         }
         break;
   }

   return status;
}

bool vpr::sim::NetworkNode::hasSocket	(	const vpr::Uint32	port,
		const vpr::SocketTypes::Type	type
	)

Checks to see if this node currently has a socket of the given type in use on the named port.

Definition at line 91 of file NetworkNode.cpp.

References vpr::SocketTypes::DATAGRAM, and vpr::SocketTypes::STREAM.

Referenced by addSocket(), getSocket(), and removeSocket().

{
   bool result = false;

   switch (type)
   {
      case vpr::SocketTypes::DATAGRAM:
         //mDgramMapMutex.acquire();
         result = (mDgramSocketMap.find(port) != mDgramSocketMap.end());
         //mDgramMapMutex.release();
         break;
      case vpr::SocketTypes::STREAM:
         //mStreamMapMutex.acquire();
         result = (mStreamSocketMap.find(port) != mStreamSocketMap.end());;
         //mStreamMapMutex.release();
         break;
   }

   return  result;
}

vpr::SocketImplSIM * vpr::sim::NetworkNode::getSocket	(	const vpr::Uint32	port,
		const vpr::SocketTypes::Type	type
	)

Definition at line 113 of file NetworkNode.cpp.

References vpr::SocketTypes::DATAGRAM, hasSocket(), vpr::SocketTypes::STREAM, and vprASSERT.

{
   vprASSERT( hasSocket(port,type) && "getSocket doesn't have a socket of the given type");

   switch (type)
   {
      case vpr::SocketTypes::DATAGRAM:
         {
            //vpr::Guard<vpr::Mutex> guard(mDgramMapMutex);
            return mDgramSocketMap[port];
         }         
         break;
      case vpr::SocketTypes::STREAM:
         {
            //vpr::Guard<vpr::Mutex> guard(mStreamMapMutex);
            return mStreamSocketMap[port];
         }
         break;
   }

   return NULL;
}

const vpr::Uint32& vpr::sim::NetworkNode::getIndex

(

)

const [inline]

Definition at line 109 of file NetworkNode.h.

   {
      return mIndex;
   }

void vpr::sim::NetworkNode::setIndex

(

const vpr::Uint32

index

)

[inline]

Definition at line 114 of file NetworkNode.h.

   {
      mIndex = index;
   }

const vpr::Uint8& vpr::sim::NetworkNode::getType

(

)

const [inline]

Definition at line 119 of file NetworkNode.h.

   {
      return mType;
   }

void vpr::sim::NetworkNode::setType

(

const vpr::Uint8

type

)

[inline]

Definition at line 124 of file NetworkNode.h.

   {
      mType = type;
   }

const vpr::Uint32& vpr::sim::NetworkNode::getIpAddress

(

)

const [inline]

Retrieves the 32-bit IPv4 address for this network node.

Definition at line 132 of file NetworkNode.h.

   {
      return mIpAddr;
   }

const std::string& vpr::sim::NetworkNode::getIpAddressString

(

)

const [inline]

Definition at line 137 of file NetworkNode.h.

   {
      return mIpStr;
   }

vpr::Uint32 vpr::sim::NetworkNode::getUnassignedTcpPortNumber

(

)

Get an unused TCP port number.

Definition at line 224 of file NetworkNode.cpp.

References vpr::prof::next(), and vprASSERT.

{
//vpr::Guard<vpr::Mutex> guard(mStreamMapMutex);

   vpr::Uint32 ret_val(1);
   bool        found_one(false);
   for(socket_map_t::iterator i = mStreamSocketMap.begin();
       (!found_one) && (i != mStreamSocketMap.end()); ++i)
   {
      socket_map_t::iterator next = i; ++next;
      if(next != mStreamSocketMap.end())
      {
         if((*next).first != ((*i).first + 1) )     // If not sequential
         {
            ret_val = (*i).first + 1;
            found_one = true;
         }
      }
      else // There is no next, so use the one after the current
      {
         ret_val = (*i).first +1;
         found_one = true;
      }

   }

   vprASSERT( mStreamSocketMap.find(ret_val) == mStreamSocketMap.end() && "Returned a value that already exists");
   return ret_val;
}

vpr::Uint32 vpr::sim::NetworkNode::getUnassignedUdpPortNumber

(

)

Get an unused UDP port number.

Definition at line 255 of file NetworkNode.cpp.

References vpr::prof::next(), and vprASSERT.

{
//vpr::Guard<vpr::Mutex> guard(mDgramMapMutex);

   vpr::Uint32 ret_val(1);
   bool        found_one(false);
   for(socket_map_t::iterator i = mDgramSocketMap.begin();
       (!found_one) && (i != mDgramSocketMap.end()); ++i)
   {
      socket_map_t::iterator next = i; ++next;
      if(next != mDgramSocketMap.end())
      {
         if((*next).first != ((*i).first + 1) )     // If not sequential
         {
            ret_val = (*i).first + 1;
            found_one = true;
         }
      }
      else // There is no next, so use the one after the current
      {
         ret_val = (*i).first +1;
         found_one = true;
      }
   }

   vprASSERT( mDgramSocketMap.find(ret_val) == mDgramSocketMap.end() && "Returned a value that already exists");
   return ret_val;
}

---

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

• NetworkNode.h
• NetworkNode.cpp

---