vpr::SocketConnector Class Reference

Defines a factory for creating new connections both synchronously and asynchronously. More...

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

List of all members.

Public Member Functions
	SocketConnector ()
	~SocketConnector ()
vpr::ReturnStatus	connect (vpr::SocketStream &newStream, const vpr::InetAddr &remoteAddr, vpr::Interval timeout=vpr::Interval::NoTimeout, const vpr::InetAddr &localAddr=vpr::InetAddr::AnyAddr)
	Actively connects to the remote address and sets the newStream parameter to the new connection.
vpr::ReturnStatus	complete (vpr::SocketStream &newStream, const vpr::Interval timeout=vpr::Interval::NoTimeout)
	Tries to complete a non-blocking connection.
Protected Member Functions
bool	checkOpen (SocketStream &newStream)
	Makes sure that we have opened the socket.
bool	connectStart (vpr::SocketStream &newStream, vpr::Interval timeout=vpr::Interval::NoTimeout, const vpr::InetAddr &localAddr=vpr::InetAddr::AnyAddr)
	Performs pre-connection rituals.

---

Detailed Description

Defines a factory for creating new connections both synchronously and asynchronously.

The socket factory creates a new socket for the user that connects to the given remote destination. It allows for synchronous and async connection establishment.

This means that there is no state associated with the connector.

Definition at line 65 of file SocketConnector.h.

---

Constructor & Destructor Documentation

vpr::SocketConnector::SocketConnector

(

)

[inline]

Definition at line 68 of file SocketConnector.h.

  {;}

vpr::SocketConnector::~SocketConnector

(

)

[inline]

Definition at line 71 of file SocketConnector.h.

  {;}

---

Member Function Documentation

vpr::ReturnStatus vpr::SocketConnector::connect	(	vpr::SocketStream &	newStream,
		const vpr::InetAddr &	remoteAddr,
		vpr::Interval	timeout = vpr::Interval::NoTimeout,
		const vpr::InetAddr &	localAddr = vpr::InetAddr::AnyAddr
	)

Actively connects to the remote address and sets the newStream parameter to the new connection.

Parameters:

	newStream	The stream to connect.
	remoteAddr	The remote address to which we will connect.
	timeout	The num msecs to wait (0 - NonBlocking).
	localAddr	Our local address. This defaults to vpr::InetAddr::AnyAddr.

Definition at line 52 of file SocketConnector.cpp.

References checkOpen(), vpr::Socket_t< SockConfig_ >::connect(), connectStart(), vpr::ReturnStatus::Fail, and vpr::Socket_t< SockConfig_ >::setRemoteAddr().

{
    vpr::ReturnStatus ret_val;
    //vpr::InetAddr remote_addr;

    // Open the socket
    if(!checkOpen(newStream))
    {
        return vpr::ReturnStatus(vpr::ReturnStatus::Fail);
    }

    /*  This actually happens in connect start
    if ( localAddr != vpr::InetAddr::AnyAddr )
    {
       vpr::ReturnStatus status;
       newStream.setLocalAddr(localAddr);
       status = newStream.bind();
       vprASSERT(status.success() && "Failed to bind local address");
    }
    */

    // Start the connection
    if(!connectStart(newStream, timeout, localAddr))
    {
       return vpr::ReturnStatus(vpr::ReturnStatus::Fail);
    }

    newStream.setRemoteAddr(remoteAddr);

    // Attempt the connection
    ret_val = newStream.connect(timeout);

    /*
    // If the connect call did not return success, it may be the result of
    // using non-blocking sockets.
    if ( ! ret_val.success() )
    {
       // If connect() gave us a status saying that the connection is in
       // progress, try to complete the connection after the timeout period.
       // If there is no timeout period, simply return immediately.
       if ( ret_val == vpr::ReturnStatus::InProgress ||
            ret_val == vpr::ReturnStatus::WouldBlock )
       {
          if ( timeout != vpr::Interval::NoWait ) {
             ret_val = complete(newStream, &remote_addr, timeout);
          }
       }
    }
    // Finish up successful connection.
    else if(vpr::Interval::NoWait != timeout) {
       ret_val = complete(newStream, &remote_addr, timeout);
    }
    */

    /*
    ** Since complete doesn't do anything really we don't need this
    if(ret_val.success())
    {
       ret_val = complete(newStream, timeout);
    }
    */

    return ret_val;
}

vpr::ReturnStatus vpr::SocketConnector::complete	(	vpr::SocketStream &	newStream,
		const vpr::Interval	timeout = vpr::Interval::NoTimeout
	)

Tries to complete a non-blocking connection.

Definition at line 122 of file SocketConnector.cpp.

References vpr::Selector_t< RealSelectorImp >::addHandle(), vpr::Socket_t< SockConfig_ >::getHandle(), vpr::Selector_t< RealSelectorImp >::getOut(), vpr::Socket_t< SockConfig_ >::isBlocking(), vpr::Socket_t< SockConfig_ >::isConnected(), vpr::SelectorBase::Read, vpr::Selector_t< RealSelectorImp >::select(), vpr::Selector_t< RealSelectorImp >::setIn(), vpr::ReturnStatus::Succeed, vprASSERT, and vpr::SelectorBase::Write.

{
   vpr::ReturnStatus status;

   if( newStream.isConnected() )
   {
      // XXX: Should this actually be a failure
      return vpr::ReturnStatus::Succeed;
   }

   // If non-blocking, then we can only wait as long as the timeout
   if ( ! newStream.isBlocking() )
   {
      vpr::IOSys::Handle handle;
      vpr::Selector selector;
      vpr::Uint16 num_events;

      // Use the selector to be informed when the SocketStream object is ready
      // to be used.  That is, when the object is connected.
      handle = newStream.getHandle();
      selector.addHandle(handle);
      selector.setIn(handle, vpr::Selector::Read | vpr::Selector::Write);
      status = selector.select(num_events, timeout);

      // If the selector told us that our handle is ready, we are successfully
      // connected.
      if ( selector.getOut(handle) & (vpr::Selector::Read | vpr::Selector::Write) )
      {
         status = vpr::ReturnStatus::Succeed;

         /*
         if ( remoteAddr != NULL ) {
            (*remoteAddr) = newStream.getRemoteAddr();
         }
         */
      }
      // else Use the status from the selector
   }
   else     // Not a non-blocking socket
   {
      vprASSERT(false && "Should not call complete on a non-blocking socket");
      /*
      if ( remoteAddr != NULL ) {
         (*remoteAddr) = newStream.getRemoteAddr();
      }
      */
   }

   return status;
}

bool vpr::SocketConnector::checkOpen

(

SocketStream &

newStream

)

[protected]

Makes sure that we have opened the socket.

If not, then open it with the given parameters.

Definition at line 174 of file SocketConnector.cpp.

References vpr::Socket_t< SockConfig_ >::isOpen(), vpr::Socket_t< SockConfig_ >::open(), vpr::ReturnStatus::success(), vprDBG_ALL(), vprDBG_CRITICAL_LVL, vprDEBUG, and vprDEBUG_FLUSH.

Referenced by connect().

{
   vpr::ReturnStatus status;

   if (!newStream.isOpen())
   {
       status = newStream.open();

       if(!status.success())
       {
          vprDEBUG(vprDBG_ALL,vprDBG_CRITICAL_LVL)
             << "vpr::Connector:CheckOpen: Failed to open socket\n"
             << vprDEBUG_FLUSH;
       }
   }

   return status.success();
}

bool vpr::SocketConnector::connectStart	(	vpr::SocketStream &	newStream,
		vpr::Interval	timeout = vpr::Interval::NoTimeout,
		const vpr::InetAddr &	localAddr = vpr::InetAddr::AnyAddr
	)			[protected]

Performs pre-connection rituals.

If we are not bound, then bind to the given local address. If timeout is vpr::Interval::NoWait, then try to set non-blocking status.

Definition at line 196 of file SocketConnector.cpp.

References vpr::Socket_t< SockConfig_ >::bind(), vpr::Socket_t< SockConfig_ >::isBound(), vpr::Socket_t< SockConfig_ >::isOpen(), vpr::Interval::NoWait, vpr::Socket_t< SockConfig_ >::setBlocking(), vpr::Socket_t< SockConfig_ >::setLocalAddr(), vpr::ReturnStatus::success(), and vprASSERT.

Referenced by connect().

{
   vprASSERT(newStream.isOpen());

   if(!newStream.isBound())      // If we are not bound yet
   {
      // If timeout is 0, then we are non-blocking
      if(vpr::Interval::NoWait == timeout)
      {
         newStream.setBlocking(false);
      }

      // Set addr and bind
      if(!newStream.setLocalAddr(localAddr).success())
      {
         return false;
      }

      if(!newStream.bind().success())
      {
         return false;
      }
   }

   return true;
}

---

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

• SocketConnector.h
• SocketConnector.cpp

---