---

vpr::SocketStreamImplSIM Class Reference

Simulated stream sockets. More...

#include <SocketStreamImplSIM.h>

Inheritance diagram for vpr::SocketStreamImplSIM:

[legend]Collaboration diagram for vpr::SocketStreamImplSIM:

[legend]List of all members.

Public Methods
	SocketStreamImplSIM (void)
	Default constructor. More...
	SocketStreamImplSIM (const vpr::InetAddr &local_addr, const vpr::InetAddr &remote_addr)
	Constructor. More...
virtual	~SocketStreamImplSIM (void)
	Destructor. More...
vpr::ReturnStatus	listen (const int backlog=5)
	Puts this socket into the listening state where it listens for incoming connection requests. More...
vpr::ReturnStatus	accept (SocketStreamImplSIM &client_sock, vpr::Interval timeout=vpr::Interval::NoTimeout)
	Accepts an incoming connection request and return the connected socket to the caller in the given socket object reference. More...
vpr::ReturnStatus	setNoDelay (bool setting)
	Sets the current no-delay status for this socket. More...
vpr::ReturnStatus	addConnector (vpr::SocketImplSIM *peerSock)
vpr::Uint32	getConnectorCount (void) const
	Gets the current number of connectors waiting to connect to this socket. More...
virtual vpr::ReturnStatus	isReadReady () const
	Tests if this socket can read without blocking. More...
virtual vpr::ReturnStatus	isWriteReady () const
	Tests if this socket can write without blocking. More...
Protected Attributes
std::queue< SocketStreamImplSIM * >	mConnectorQueue
	< Queue of pending connection requests.This is a list of the requesting connectors. More...
vpr::Mutex	mConnectorQueueMutex
	Mutex for connector queue. More...
bool	mNoDelay

---

Detailed Description

Simulated stream sockets.

Author:

Kevin Meinert , Patrick Hartling

Definition at line 65 of file SocketStreamImplSIM.h.

---

Constructor & Destructor Documentation

vpr::SocketStreamImplSIM::SocketStreamImplSIM (  void    )  [inline]

Default constructor. This initializes the member variables. Definition at line 75 of file SocketStreamImplSIM.h. References vpr::SocketTypes::STREAM. Referenced by accept, and addConnector. : SocketImplSIM(vpr::SocketTypes::STREAM), mNoDelay(false) { /* Do nothing. */ ; }

vpr::SocketStreamImplSIM::SocketStreamImplSIM (  const vpr::InetAddr &    local_addr, const vpr::InetAddr &    remote_addr )  [inline]

Constructor. This initializes the member variables. In particular, the local and remote addresses for this socket are initialized using the given addresses. Postcondition: The member variables are initialized with the mType variable in particular set to SOCK_STREAM. Parameters: local_addr  The local address for this socket (the one it is bound to). remote_addr  The remote address for this socket. This is used for a socket that will connect to another socket. Definition at line 94 of file SocketStreamImplSIM.h. References vpr::SocketTypes::STREAM. : SocketImplSIM(local_addr, remote_addr, vpr::SocketTypes::STREAM), mNoDelay( false ) { mLocalAddr = local_addr; mRemoteAddr = remote_addr; }

virtual vpr::SocketStreamImplSIM::~SocketStreamImplSIM (  void    )  [inline, virtual]

Destructor. This currently does nothing but act as a placeholder. Definition at line 106 of file SocketStreamImplSIM.h. { /* Do nothing. */ ; }

---

Member Function Documentation

vpr::ReturnStatus vpr::SocketStreamImplSIM::listen (  const int    backlog = 5 )

Puts this socket into the listening state where it listens for incoming connection requests. Precondition: The socket has been opened and bound to the address in mLocalAddr. Postcondition: The socket is in a listening state waiting for incoming connection requests. Parameters: backlog  The maximum length of the queue of pending connections. Returns: vpr::ReturnStatus::Success is returned if this socket is now in a listening state. vpr::ReturnStatus::Failure is returned otherwise. Definition at line 55 of file SocketStreamImplSIM.cpp. References vpr::sim::Controller::instance. { return vpr::sim::Controller::instance()->getSocketManager().listen(this, backlog); }

vpr::ReturnStatus vpr::SocketStreamImplSIM::accept (  SocketStreamImplSIM &    client_sock, vpr::Interval    timeout = vpr::Interval::NoTimeout )

Accepts an incoming connection request and return the connected socket to the caller in the given socket object reference. Precondition: The socket is open and is in a listening state. Postcondition: When a connection is established, the given vpr::SocketStream object is assigned the newly connected socket. Parameters: sock  A reference to a vpr::SocketStream object that will be used to return the connected socket created. timeout  The length of time to wait for the accept call to return. Returns: vpr::ReturnStatus::Success is returned if the incoming request has been handled, and the given SocketStream object is a valid, connected socket. vpr::ReturnStatus::WouldBlock is returned if this is a non-blocking socket, and there are no waiting connection requests. vpr::ReturnStatus::Timeout is returned when no connections requests arrived within the given timeout period. vpr::ReturnStatus::Failure is returned if the accept failed. The given vpr::SocketStream object is not modified in this case. Definition at line 60 of file SocketStreamImplSIM.cpp. References vpr::MutexPosix::acquire, vpr::sim::Controller::addConnectionCompletionEvent, vpr::sim::SocketManager::findRoute, vpr::sim::Controller::getClock, vpr::sim::Clock::getCurrentTime, vpr::sim::Controller::getSocketManager, vpr::sim::Controller::instance, vpr::SocketImplSIM::mBlocking, mConnectorQueue, mConnectorQueueMutex, vpr::SocketImplSIM::mLocalAddr, vpr::MutexPosix::release, vpr::ReturnStatus::setCode, vpr::InetAddrBSD::setPort, SocketStreamImplSIM, vprASSERT, vprDBG_ALL, vprDBG_STATE_LVL, vprDEBUG, vprDEBUG_FLUSH, and vpr::ReturnStatus::WouldBlock. { vpr::ReturnStatus status; mConnectorQueueMutex.acquire(); if ( ! mConnectorQueue.empty() ) { SocketStreamImplSIM* peer_ptr = mConnectorQueue.front(); // The peer requesting the connection mConnectorQueue.pop(); mConnectorQueueMutex.release(); vprDEBUG(vprDBG_ALL, vprDBG_STATE_LVL) << "SocketStreamImplSIM::accept() [" << mLocalAddr << "]: Got pending connector from " << peer_ptr->getLocalAddr() << "\n" << vprDEBUG_FLUSH; // -- Set known properties of the next socket client_sock.mRemoteAddr = peer_ptr->mLocalAddr; // Get the remote node's address (it must have called bind, so this is final) client_sock.mOpen = true; client_sock.mBlocking = mBlocking; client_sock.setConnectState(peer_ptr); // Get an address for the new socket, bind it, and attach the socket to // the correct node. vpr::sim::Controller* controller = vpr::sim::Controller::instance(); vpr::sim::SocketManager& sock_mgr = controller->getSocketManager(); client_sock.mLocalAddr = mLocalAddr; // Start with local socket's address client_sock.mLocalAddr.setPort(0); // Clear port so that we get a unique one client_sock.bind(); // Bind to a port (and assign to net node) // Now define the route for messages between the two sockets. // - Sets the path inside both sockets (path to the other socket) sock_mgr.findRoute(peer_ptr, client_sock.getHandle()); peer_ptr->completeConnection( client_sock.getHandle() ); controller->addConnectionCompletionEvent(controller->getClock().getCurrentTime(), peer_ptr); // Make sure the peer's remote address has the right address. // Prior to this point, it has the port of the accepting socket. vprASSERT(peer_ptr->mRemoteAddr == client_sock.mLocalAddr && "Connector doesn't know peer's IP address"); } else { mConnectorQueueMutex.release(); status.setCode(vpr::ReturnStatus::WouldBlock); } return status; }

vpr::ReturnStatus vpr::SocketStreamImplSIM::setNoDelay (  bool    setting )  [inline]

Sets the current no-delay status for this socket. If no-delay is true, then the Nagel algorithm will be disabled. Of course, there is no Nagel algorithm for sim sockets. Parameters: enable_val  The Boolean enable/disable state for no-delay on this socket. Definition at line 161 of file SocketStreamImplSIM.h. { mNoDelay = setting; return vpr::ReturnStatus(); }

vpr::ReturnStatus vpr::SocketStreamImplSIM::addConnector (  vpr::SocketImplSIM *    peerSock )

Parameters: connector  The socket making the connection. Definition at line 115 of file SocketStreamImplSIM.cpp. References vpr::MutexPosix::acquire, vpr::SocketImplSIM::getLocalAddr, vpr::ReturnStatus::InProgress, mConnectorQueue, mConnectorQueueMutex, vpr::SocketImplSIM::mLocalAddr, vpr::MutexPosix::release, SocketStreamImplSIM, vprASSERT, vprDBG_ALL, vprDBG_STATE_LVL, vprDEBUG, and vprDEBUG_FLUSH. Referenced by vpr::sim::SocketManager::connect. { SocketStreamImplSIM* stream_remote; vprDEBUG(vprDBG_ALL, vprDBG_STATE_LVL) << "SocketStreamImplSIM::addConnector() [" << mLocalAddr << "]: Adding connector from " << peerSock->getLocalAddr() << "\n" << vprDEBUG_FLUSH; stream_remote = dynamic_cast<SocketStreamImplSIM*>(peerSock); vprASSERT(NULL != stream_remote && "Tried to connect to a non-stream socket!"); mConnectorQueueMutex.acquire(); { mConnectorQueue.push(stream_remote); } mConnectorQueueMutex.release(); return vpr::ReturnStatus(vpr::ReturnStatus::InProgress); }

vpr::Uint32 vpr::SocketStreamImplSIM::getConnectorCount (  void    )  const [inline]

Gets the current number of connectors waiting to connect to this socket. Definition at line 176 of file SocketStreamImplSIM.h. Referenced by isReadReady. { return mConnectorQueue.size(); }

vpr::ReturnStatus vpr::SocketStreamImplSIM::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 137 of file SocketStreamImplSIM.cpp. References vpr::ReturnStatus::Fail, getConnectorCount, vpr::SocketImplSIM::isConnected, vpr::SocketImplSIM::isOpen, vpr::SocketImplSIM::mArrivedQueue, vpr::ReturnStatus::setCode, and vpr::ReturnStatus::Succeed. { vpr::ReturnStatus status(vpr::ReturnStatus::Fail); // To be able to read, we must be open, connected, and have a non-empty // queue of arrived messages. if ( isOpen() && isConnected() && (! mArrivedQueue.empty()) ) { status.setCode(vpr::ReturnStatus::Succeed); } if ( isOpen() && getConnectorCount() > 0 ) { status.setCode(vpr::ReturnStatus::Succeed); } return status; }

vpr::ReturnStatus vpr::SocketStreamImplSIM::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 156 of file SocketStreamImplSIM.cpp. References vpr::ReturnStatus::Fail, vpr::SocketImplSIM::isConnected, vpr::SocketImplSIM::isOpen, and vpr::ReturnStatus::setCode. { vpr::ReturnStatus status; // We cannot write if we are not open or we not are connected. if ( ! isOpen() || ! isConnected() ) { status.setCode(vpr::ReturnStatus::Fail); } return status; }

---

Member Data Documentation

std::queue<SocketStreamImplSIM*> vpr::SocketStreamImplSIM::mConnectorQueue [protected]

< Queue of pending connection requests.This is a list of the requesting connectors. Definition at line 187 of file SocketStreamImplSIM.h. Referenced by accept, and addConnector.

vpr::Mutex vpr::SocketStreamImplSIM::mConnectorQueueMutex [protected]

Mutex for connector queue. Definition at line 188 of file SocketStreamImplSIM.h. Referenced by accept, and addConnector.

bool vpr::SocketStreamImplSIM::mNoDelay [protected]

Definition at line 190 of file SocketStreamImplSIM.h.

---

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

• SocketStreamImplSIM.h
• SocketStreamImplSIM.cpp

---