---

vpr::SocketStreamImplBSD Class Reference

Implementation of the stream socket wrapper using BSD sockets. More...

#include <SocketStreamImplBSD.h>

Inheritance diagram for vpr::SocketStreamImplBSD:

[legend]Collaboration diagram for vpr::SocketStreamImplBSD:

[legend]List of all members.

Public Methods
	SocketStreamImplBSD ()
	Constructor. More...
	SocketStreamImplBSD (const InetAddr &local_addr, const InetAddr &remote_addr)
	Constructs a stream socket using the given addresses as defaults for communication channels. More...
	SocketStreamImplBSD (const SocketStreamImplBSD &sock)
	Copy constructor. 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 (SocketStreamImplBSD &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...

---

Detailed Description

Implementation of the stream socket wrapper using BSD sockets.

Definition at line 58 of file SocketStreamImplBSD.h.

---

Constructor & Destructor Documentation

vpr::SocketStreamImplBSD::SocketStreamImplBSD (    )

Constructor. Precondition: None. Postcondition: The member variables are initialized with the mType variable in particular set to vpr::SocketTypes::SOCK_STREAM. Definition at line 62 of file SocketStreamImplBSD.cpp. References vpr::SocketTypes::STREAM. : SocketImplBSD(vpr::SocketTypes::STREAM) { /* Do nothing. */ ; }

vpr::SocketStreamImplBSD::SocketStreamImplBSD (  const InetAddr &    local_addr, const InetAddr &    remote_addr )

Constructs a stream socket using the given addresses as defaults for communication channels. This takes the address (either hostname or IP address) of a remote site and a port and stores the values for later use in the member variables of the object. Postcondition: The member variables are initialized with the type in particular set to vpr::SocketTypes::STREAM. Parameters: local_addr  The local address for this socket. This is used for binding the socket. remote_addr  The remote address for this socket. This is used to specify the connection addres for this socket. Definition at line 68 of file SocketStreamImplBSD.cpp. References vpr::InetAddr, and vpr::SocketTypes::STREAM. : SocketImplBSD(local_addr, remote_addr, SocketTypes::STREAM) { /* Do nothing. */ ; }

vpr::SocketStreamImplBSD::SocketStreamImplBSD (  const SocketStreamImplBSD &    sock )

Copy constructor. Postcondition: This socket is a copy of the given socket. Definition at line 75 of file SocketStreamImplBSD.cpp. References vpr::FileHandleImplUNIX::mFdesc, vpr::SocketImplBSD::mHandle, and vpr::SocketTypes::STREAM. : SocketImplBSD(sock.mLocalAddr, sock.mRemoteAddr, SocketTypes::STREAM) { mHandle = new FileHandleImplUNIX(sock.mHandle->getName()); mHandle->mFdesc = sock.mHandle->mFdesc; }

---

Member Function Documentation

vpr::ReturnStatus vpr::SocketStreamImplBSD::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 th queue of pending connections. Returns: vpr::ReturnStatus::Succeed is returned if this socket is now in a listening state. vpr::ReturnStatus::Fail is returned otherwise. Definition at line 83 of file SocketStreamImplBSD.cpp. References errno, vpr::FileHandleImplUNIX::mFdesc, vpr::SocketImplBSD::mHandle, and vpr::ReturnStatus::setCode. { vpr::ReturnStatus retval; // Put the socket into listning mode. If that fails, print an error and // return error status. if ( ::listen(mHandle->mFdesc, backlog) == -1 ) { fprintf(stderr, "[vpr::SocketStreamImplBSD] Cannot listen on socket: %s\n", strerror(errno)); retval.setCode(ReturnStatus::Fail); } return retval; }

vpr::ReturnStatus vpr::SocketStreamImplBSD::accept (  SocketStreamImplBSD &    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::Succeed 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::Fail is returned if the accept failed. The given vpr::SocketStream object is not modified in this case. Definition at line 101 of file SocketStreamImplBSD.cpp. References errno, vpr::InetAddr, vpr::SocketImplBSD::isBlocking, vpr::FileHandleImplUNIX::isReadable, vpr::SocketImplBSD::mBlockingFixed, vpr::FileHandleImplUNIX::mFdesc, vpr::SocketImplBSD::mHandle, vpr::ReturnStatus::setCode, and vpr::ReturnStatus::success. { int accept_sock; vpr::ReturnStatus retval; InetAddr addr; #if defined(VPR_OS_IRIX) || defined(VPR_OS_HPUX) int addrlen; #else socklen_t addrlen; #endif retval = mHandle->isReadable(timeout); if ( retval.success() ) { mBlockingFixed = true; // Accept an incoming connection request. addrlen = addr.size(); accept_sock = ::accept(mHandle->mFdesc, (struct sockaddr*) &addr.mAddr, &addrlen); // If accept(2) failed, print an error message and return error stauts. if ( accept_sock == -1 ) { if ( errno == EWOULDBLOCK && ! isBlocking() ) { retval.setCode(ReturnStatus::WouldBlock); } else { fprintf(stderr, "[vpr::SocketStreamImplBSD] Error while accepting " "incoming connection: %s\n", strerror(errno)); retval.setCode(ReturnStatus::Fail); } } // Otherwise, put the new socket in the passed socket object. else { sock.setRemoteAddr(addr); sock.mHandle = new FileHandleImplUNIX(addr.getAddressString()); sock.mHandle->mFdesc = accept_sock; sock.mHandle->mOpen = true; sock.setBlocking(this->isBlocking()); sock.mBound = true; sock.mConnected = true; sock.mBlockingFixed = true; } } return retval; }

---

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

• SocketStreamImplBSD.h
• SocketStreamImplBSD.cpp

---