---

vpr::SocketImplBSD Class Reference

Basic socket wrapper implementation for BSD sockets. More...

#include <SocketImplBSD.h>

Inheritance diagram for vpr::SocketImplBSD:

[legend]Collaboration diagram for vpr::SocketImplBSD:

[legend]List of all members.

Public Methods
const std::string &	getName () const
	Gets the "name" of this socket. More...
vpr::ReturnStatus	open ()
	Opens the socket. More...
vpr::ReturnStatus	close ()
	Close the socket. More...
bool	isOpen () const
	Gets the open state of this socket. More...
bool	isBound () const
vpr::ReturnStatus	bind ()
	Binds this socket to the address in the host address member variable. More...
vpr::IOSys::Handle	getHandle () const
	Returns the contained handle. More...
bool	isBlockingFixed () const
	Queries if the blocking state for this socket is fixed and can no longer be changed. More...
vpr::ReturnStatus	setBlocking (bool blocking)
	Reconfigures the socket so that it is in blocking or non-blocking mode. More...
bool	isBlocking () const
	Gets the current blocking state for the socket. More...
vpr::ReturnStatus	connect (vpr::Interval timeout=vpr::Interval::NoTimeout)
	Connects the socket on the client side to the server side. More...
bool	isConnected () const
	Gets the status of a possibly connected socket. More...
const vpr::SocketTypes::Type &	getType () const
	Gets the type of this socket (e.g., vpr::SocketTypes::STREAM). More...
const vpr::InetAddr &	getLocalAddr () const
	Gets the type of this socket (e.g., vpr::SocketTypes::STREAM). More...
vpr::ReturnStatus	setLocalAddr (const vpr::InetAddr &addr)
	Changes the local address for this socket. More...
const vpr::InetAddr &	getRemoteAddr () const
	Returns the remote address for this socket. More...
vpr::ReturnStatus	setRemoteAddr (const vpr::InetAddr &addr)
	Changes the remote address for this socket. More...
vpr::ReturnStatus	read_i (void *buffer, const vpr::Uint32 length, vpr::Uint32 &bytes_read, const vpr::Interval timeout=vpr::Interval::NoTimeout)
	Implementation of the read template method. More...
vpr::ReturnStatus	readn_i (void *buffer, const vpr::Uint32 length, vpr::Uint32 &bytes_read, const vpr::Interval timeout=vpr::Interval::NoTimeout)
	Implementation of the readn template method. More...
vpr::ReturnStatus	write_i (const void *buffer, const vpr::Uint32 length, vpr::Uint32 &bytes_written, const vpr::Interval timeout=vpr::Interval::NoTimeout)
	Implementation of the write template method. More...
vpr::Uint32	availableBytes () const
vpr::ReturnStatus	getOption (const vpr::SocketOptions::Types option, struct vpr::SocketOptions::Data &data) const
	Retrieves the value for the given option as set on the socket. More...
vpr::ReturnStatus	setOption (const vpr::SocketOptions::Types option, const struct vpr::SocketOptions::Data &data)
	Do nothing. More...
	~SocketImplBSD ()
	Destructor. More...
Protected Methods
	SocketImplBSD (const vpr::SocketTypes::Type sock_type)
	Default constructor. More...
	SocketImplBSD (const vpr::InetAddr &local_addr, const vpr::InetAddr &remote_addr, const vpr::SocketTypes::Type sock_type)
	Standard constructor. More...
Protected Attributes
bool	mOpenBlocking
	Used for working around socket(2) semantics. More...
bool	mBound
bool	mConnected
bool	mBlockingFixed
vpr::FileHandleImplUNIX *	mHandle
	The OS handle for this socket. More...
vpr::InetAddr	mLocalAddr
	The local site's address structure. More...
vpr::InetAddr	mRemoteAddr
	The remote site's address structure. More...
vpr::SocketTypes::Type	mType
	The type for this socket. More...

---

Detailed Description

Basic socket wrapper implementation for BSD sockets.

Definition at line 63 of file SocketImplBSD.h.

---

Constructor & Destructor Documentation

vpr::SocketImplBSD::~SocketImplBSD (    )

Destructor. This releases the memory allocated for mHandle (if it is non-NULL). Precondition: If mHandle is NULL, its memory has already been deleted. Postcondition: The memory for mHandle is deleted. Definition at line 767 of file SocketImplBSD.cpp. References mHandle. { if ( mHandle != NULL ) { delete mHandle; mHandle = NULL; } }

vpr::SocketImplBSD::SocketImplBSD (  const vpr::SocketTypes::Type    sock_type )  [protected]

Default constructor. This just initializes member variables to reasonable defaults. Postcondition: The member variables are initialized accordingly to reasonable defaults. Definition at line 780 of file SocketImplBSD.cpp. References mHandle. : mOpenBlocking(true) , mBound(false) , mConnected(false) , mBlockingFixed(false) , mHandle(NULL) , mType(sock_type) { mHandle = new FileHandleImplUNIX(); }

vpr::SocketImplBSD::SocketImplBSD (  const vpr::InetAddr &    local_addr, const vpr::InetAddr &    remote_addr, const vpr::SocketTypes::Type    sock_type )  [protected]

Standard constructor. This takes two vpr::InetAddr objects, a local address and a remote address. Postcondition: The member variables are initialized with the given values. Parameters: local_addr  The local address for the socket. remote_addr  The remote address for the socket. sock_type  The type for this socket (stream, datagram, etc.). Definition at line 791 of file SocketImplBSD.cpp. References vpr::InetAddrBSD::getAddressString, and mHandle. : mOpenBlocking(true) , mBound(false) , mConnected(false) , mBlockingFixed(false) , mHandle(NULL) , mLocalAddr(local_addr) , mRemoteAddr(remote_addr) , mType(sock_type) { mHandle = new FileHandleImplUNIX(remote_addr.getAddressString()); }

---

Member Function Documentation

const std::string & vpr::SocketImplBSD::getName (    )  const

Gets the "name" of this socket. It is typically the address of the peer host. Precondition: None. Returns: An object containing the "name" of this socket. Definition at line 66 of file SocketImplBSD.cpp. References vpr::FileHandleImplUNIX::getName, and mHandle. Referenced by open. { return mHandle->getName(); }

vpr::ReturnStatus vpr::SocketImplBSD::open (    )

Opens the socket. This creates a new socket using the domain and type options set through member variables. Precondition: mDomain and mType have been set to values recognized by the socket(2) system call. Postcondition: A new socket is created with its file handle stored in the mFdesc member variable. Returns: vpr::ReturnStatus::Succeed is returned if the socket was opened successfully. vpr::ReturnStatus::Fail is returned otherwise. Definition at line 73 of file SocketImplBSD.cpp. References errno, vpr::ReturnStatus::Fail, vpr::InetAddrBSD::getAddressString, vpr::InetAddrBSD::getFamily, getName, vpr::FileHandleImplUNIX::mFdesc, mHandle, mLocalAddr, vpr::FileHandleImplUNIX::mOpen, mOpenBlocking, mRemoteAddr, vpr::FileHandleImplUNIX::setBlocking, and vpr::ReturnStatus::setCode. { int domain, type, sock; vpr::ReturnStatus retval; switch ( mLocalAddr.getFamily() ) { case SocketTypes::LOCAL: #ifdef PF_LOCAL domain = PF_LOCAL; #else domain = PF_UNIX; #endif break; case SocketTypes::INET: domain = PF_INET; break; case SocketTypes::INET6: #ifdef PF_INET6 domain = PF_INET6; #else fprintf(stderr, "[vpr::SocketImplBSD] WARNING: IPv6 not supported on this host!\n"); #endif break; case SocketTypes::LINK: #if defined(PF_LINK) domain = PF_LINK; #elif defined(PF_RAW) domain = PF_RAW; #else fprintf(stderr, "[vpr::SocketImplBSD] WARNING: Cannot use LINK sockets. domain %d\n", mLocalAddr.getFamily()); #endif break; default: domain = -1; fprintf(stderr, "[vpr::SocketImplBSD] ERROR: Unknown socket domain value %d\n", mLocalAddr.getFamily()); break; } switch ( mType ) { case SocketTypes::STREAM: type = SOCK_STREAM; break; case SocketTypes::DATAGRAM: type = SOCK_DGRAM; break; case SocketTypes::RAW: type = SOCK_RAW; break; default: type = -1; fprintf(stderr, "[vpr::SocketImplBSD] ERROR: Unknown socket type value %d\n", mLocalAddr.getFamily()); break; } // Attempt to create a new socket using the values in mLocalAddr and // mType. sock = socket(domain, type, 0); // If socket(2) failed, print an error message and return error status. if ( sock == -1 ) { fprintf(stderr, "[vpr::SocketImplBSD] Could not create socket (%s): %s\n", getName().c_str(), strerror(errno)); retval.setCode(vpr::ReturnStatus::Fail); } // Otherwise, return success. else { if ( mHandle == NULL ) { mHandle = new FileHandleImplUNIX(mRemoteAddr.getAddressString()); } mHandle->mFdesc = sock; mHandle->mOpen = true; // Since socket(2) cannot open a socket in non-blocking mode, we call // vpr::FileHandleUNIX::setBlocking() directly. retval = mHandle->setBlocking(mOpenBlocking); } return retval; }

vpr::ReturnStatus vpr::SocketImplBSD::close (    )

Close the socket. Precondition: The socket is open. Postcondition: An attempt is made to close the socket. The resulting status is returned to the caller. Returns: vpr::ReturnStatus::Succeed is returned if the socket was closed successfully; vpr::ReturnStatus::Fail otherwise. Definition at line 167 of file SocketImplBSD.cpp. References vpr::FileHandleImplUNIX::close, and mHandle. { return mHandle->close(); }

bool vpr::SocketImplBSD::isOpen (    )  const [inline]

Gets the open state of this socket. Precondition: None. Postcondition: The boolean value giving the open state is returned to the caller. Returns: true is returned if this socket is open; false otherwise. Definition at line 116 of file SocketImplBSD.h. References vpr::FileHandleImplUNIX::isOpen, and mHandle. Referenced by isConnected, and setBlocking. { return mHandle->isOpen(); }

bool vpr::SocketImplBSD::isBound (    )  const [inline]

Definition at line 121 of file SocketImplBSD.h. References mBound. { return mBound; }

vpr::ReturnStatus vpr::SocketImplBSD::bind (    )

Binds this socket to the address in the host address member variable. Precondition: The socket is open, and mLocalAddr has been initialized properly. Postcondition: The socket is bound to the address in mLocalAddr. Returns: vpr::ReturnStatus::Sucess is returned if the socket was bound to the address successfully. vpr::ReturnStatus::Fail is returned if the socket could not be bound to the address in mLocalAddr. Definition at line 198 of file SocketImplBSD.cpp. References errno, vpr::ReturnStatus::Fail, mBound, vpr::FileHandleImplUNIX::mFdesc, mHandle, mLocalAddr, and vpr::ReturnStatus::setCode. { vpr::ReturnStatus retval; int status; // Bind the socket to the address in mLocalAddr. status = ::bind(mHandle->mFdesc, (struct sockaddr*) &mLocalAddr.mAddr, mLocalAddr.size()); // If that fails, print an error and return error status. if ( status == -1 ) { fprintf(stderr, "[vpr::SocketImplBSD] Cannot bind socket to address: %s\n", strerror(errno)); retval.setCode(vpr::ReturnStatus::Fail); } else { mBound = true; } return retval; }

vpr::IOSys::Handle vpr::SocketImplBSD::getHandle (    )  const [inline]

Returns the contained handle. Definition at line 140 of file SocketImplBSD.h. References vpr::FileHandleImplUNIX::getHandle, and mHandle. { return mHandle->getHandle(); }

bool vpr::SocketImplBSD::isBlockingFixed (    )  const [inline]

Queries if the blocking state for this socket is fixed and can no longer be changed. Definition at line 149 of file SocketImplBSD.h. References mBlockingFixed. { return mBlockingFixed; }

vpr::ReturnStatus vpr::SocketImplBSD::setBlocking (  bool    blocking )

Reconfigures the socket so that it is in blocking or non-blocking mode. If this socket has not been opened yet, it will be opened in blocking or non-blocking mode appropriately when open() is called. Postcondition: Processes will block (or not) when accessing the socket. Parameters: blocking  A value of true indicates that the socket will be configured to use blocking I/O. A value of false indicates that it will use non-blocking I/O. Returns: vpr::ReturnStatus::Succeed is returned if the blocking mode was changed successfully; vpr::ReturnStatus::Fail otherwise. Definition at line 173 of file SocketImplBSD.cpp. References vpr::ReturnStatus::Fail, isOpen, mBlockingFixed, mHandle, mOpenBlocking, vpr::FileHandleImplUNIX::setBlocking, vpr::ReturnStatus::setCode, and vprASSERT. { vpr::ReturnStatus status; vprASSERT(! mBlockingFixed && "Cannot change blocking state after a blocking call!"); if ( ! mBlockingFixed ) { status = mHandle->setBlocking(blocking); if ( ! isOpen() ) { mOpenBlocking = blocking; } } else { status.setCode(vpr::ReturnStatus::Fail); } return status; }

bool vpr::SocketImplBSD::isBlocking (    )  const [inline]

Gets the current blocking state for the socket. Returns: true is returned if the socket is in blocking mode. Otherwise, false is returned. Definition at line 176 of file SocketImplBSD.h. References vpr::FileHandleImplUNIX::isBlocking, and mHandle. Referenced by vpr::SocketStreamImplBSD::accept, connect, vpr::SocketDatagramImplBSD::recvfrom, and vpr::SocketDatagramImplBSD::sendto. { return mHandle->isBlocking(); }

vpr::ReturnStatus vpr::SocketImplBSD::connect (  vpr::Interval    timeout = vpr::Interval::NoTimeout )

Connects the socket on the client side to the server side. For a datagram socket, this makes the address given to the constructor the default destination for all packets. For a stream socket, this has the effect of establishing a connection with the destination. Precondition: The socket is open. Postcondition: The socket is connected to the address in mLocalAddr. For a stream socket, this means that a connection for future communication has been established. For a datagram socket, the default destination for all packets is now mLocalAddr. Returns: vpr::ReturnStatus::Succeed is returned if the connection succeeded. vpr::ReturnStatus::InProgress is returned if this is a non-blocking socket and the connection is still in progress. The connection will be completed "in the background". vpr::ReturnStatus::Timeout is returned if the connection could not be made within the given timeout interval. vpr::ReturnStatus::Fail is returned if the connection could not be made. Definition at line 227 of file SocketImplBSD.cpp. References errno, vpr::ReturnStatus::Fail, vpr::InetAddrBSD::getAddressString, vpr::ReturnStatus::InProgress, isBlocking, vpr::FileHandleImplUNIX::isWriteable, mBlockingFixed, mBound, mConnected, vpr::FileHandleImplUNIX::mFdesc, mHandle, mLocalAddr, mRemoteAddr, vpr::Interval::NoWait, vpr::ReturnStatus::setCode, vpr::InetAddrBSD::setSockaddr, vpr::ReturnStatus::success, vprDBG_ALL, vprDBG_STATE_LVL, vprDBG_WARNING_LVL, vprDEBUG, and vprDEBUG_FLUSH. { vpr::ReturnStatus retval; int status; // Attempt to connect to the address in mAddr. status = ::connect(mHandle->mFdesc, (struct sockaddr*) &mRemoteAddr.mAddr, mRemoteAddr.size()); // If connect(2) failed, print an error message explaining why and return // error status. if ( status == -1 ) { // If this is a non-blocking connection, return // vpr::ReturnStatus::InProgress to indicate that the connection will // complete later. I'm not sure if it's safe to set mConnected and // mBlockingFixed at this point, but they have to be set sometime. if ( errno == EINPROGRESS && ! isBlocking() ) { if ( vpr::Interval::NoWait == timeout ) { retval.setCode(vpr::ReturnStatus::InProgress); } // If we have a timeout value, wait for at most the duration of // that interval. If we time out, tell the caller that the // connection is still in progress. else if ( ! mHandle->isWriteable(timeout).success() ) { retval.setCode(vpr::ReturnStatus::InProgress); } mBound = true; mConnected = true; mBlockingFixed = true; } else { // fprintf(stderr, "[vpr::SocketImplBSD] Error connecting to %s: %s\n", // mRemoteAddr.getAddressString().c_str(), strerror(errno)); vprDEBUG(vprDBG_ALL, vprDBG_STATE_LVL) << "[vpr::SocketImplBSD] Error connecting to " << mRemoteAddr.getAddressString() << ": " << strerror(errno) << std::endl << vprDEBUG_FLUSH; retval.setCode(vpr::ReturnStatus::Fail); } } // Otherwise, return success. else { mBound = true; mConnected = true; mBlockingFixed = true; } // Fill in the local address if has not already been assigned. if ( mConnected && vpr::InetAddr::AnyAddr == mLocalAddr ) { int status; #if defined(VPR_OS_IRIX) || defined(VPR_OS_HPUX) int namelen; #else socklen_t namelen; #endif struct sockaddr temp_addr; namelen = sizeof(struct sockaddr); status = getsockname(mHandle->mFdesc, &temp_addr, &namelen); if ( status == 0 ) { mLocalAddr.setSockaddr(&temp_addr); /* XXX: This doesn't compile on IRIX, and I don't know why. vprDEBUG(vprDBG_ALL, vprDBG_STATE_LVL) << "Connected, local address is " << mLocalAddr << std::endl << vprDEBUG_FLUSH; */ } else { vprDEBUG(vprDBG_ALL, vprDBG_WARNING_LVL) << "Failed to get sock name: " << strerror(errno) << std::endl << vprDEBUG_FLUSH; } } return retval; }

bool vpr::SocketImplBSD::isConnected (    )  const

Gets the status of a possibly connected socket. Precondition: This socket is opened and has been connected to a peer. Returns: true is returned if this socket is still connected. false is returned if this socket is not currently connected. Definition at line 315 of file SocketImplBSD.cpp. References vpr::FileHandleImplUNIX::getReadBufferSize, isOpen, vpr::FileHandleImplUNIX::isReadable, mConnected, mHandle, vpr::Interval::NoWait, and vpr::ReturnStatus::success. { bool connected(false); if ( isOpen() && mConnected ) { vpr::ReturnStatus status; vpr::Int32 bytes; status = mHandle->getReadBufferSize(bytes); if ( status.success() ) { if ( bytes == 0 ) { // If there are no bytes to read but the OS tells us that the // socket is readable, then something is wrong. if ( ! mHandle->isReadable(vpr::Interval::NoWait).success() ) { connected = true; } } else { connected = true; } } } return connected; }

const vpr::SocketTypes::Type& vpr::SocketImplBSD::getType (    )  const [inline]

Gets the type of this socket (e.g., vpr::SocketTypes::STREAM). Precondition: The socket implementation pointer is valid. Postcondition: The socket type for this socket is returned to the caller. Returns: A vpr::SocketTypes::Type value giving the socket type for this socket. Definition at line 228 of file SocketImplBSD.h. References mType. { return mType; }

const vpr::InetAddr& vpr::SocketImplBSD::getLocalAddr (    )  const [inline]

Gets the type of this socket (e.g., vpr::SocketTypes::STREAM). Precondition: The socket implementation pointer is valid. Postcondition: The socket type for this socket is returned to the caller. Returns: A vpr::SocketTypes::Type value giving the socket type for this socket. Definition at line 242 of file SocketImplBSD.h. References mLocalAddr. { return mLocalAddr; }

vpr::ReturnStatus vpr::SocketImplBSD::setLocalAddr (  const vpr::InetAddr &    addr )

Changes the local address for this socket. Precondition: This socket is not already bound. Postcondition: mLocalAddr is updated to use the given vpr::InetAddr object. Definition at line 347 of file SocketImplBSD.cpp. References vpr::ReturnStatus::Fail, vpr::InetAddr, mBound, mConnected, mLocalAddr, vpr::ReturnStatus::setCode, vprDBG_ALL, vprDBG_CRITICAL_LVL, vprDEBUG, and vprDEBUG_FLUSH. { vpr::ReturnStatus status; if ( mBound || mConnected ) { vprDEBUG(vprDBG_ALL, vprDBG_CRITICAL_LVL) << "SocketImplBSD::setLocalAddr: Can't set address of a " << "bound or connected socket.\n" << vprDEBUG_FLUSH; status.setCode(vpr::ReturnStatus::Fail); } else { mLocalAddr = addr; } return status; }

const vpr::InetAddr& vpr::SocketImplBSD::getRemoteAddr (    )  const [inline]

Returns the remote address for this socket. This is typically the address to which this socket is connected. Definition at line 259 of file SocketImplBSD.h. References mRemoteAddr. { return mRemoteAddr; }

vpr::ReturnStatus vpr::SocketImplBSD::setRemoteAddr (  const vpr::InetAddr &    addr )

Changes the remote address for this socket. Precondition: This socket is not already connected. Postcondition: mLocalAddr is updated to use the given vpr::InetAddr object. Definition at line 366 of file SocketImplBSD.cpp. References vpr::ReturnStatus::Fail, vpr::InetAddr, mRemoteAddr, and vpr::ReturnStatus::setCode. { vpr::ReturnStatus status; if ( mConnected ) { status.setCode(vpr::ReturnStatus::Fail); } else { mRemoteAddr = addr; } return status; }

vpr::ReturnStatus vpr::SocketImplBSD::read_i (  void *    buffer, const vpr::Uint32    length, vpr::Uint32 &    bytes_read, const vpr::Interval    timeout = vpr::Interval::NoTimeout )

Implementation of the read template method. This reads at most the specified number of bytes from the socket into the given buffer. Precondition: The device is open for reading, and the buffer is at least length bytes long. Postcondition: The given buffer has length bytes copied into it from the device, and the number of bytes read successfully is returned to the caller via the bytes_read parameter. Parameters: buffer  A pointer to the buffer where the device's buffer contents are to be stored. length  The number of bytes to be read. bytes_read  The number of bytes read into the buffer. timeout  The maximum amount of time to wait for data to be available for reading. This argument is optional and defaults to vpr::Interval::NoTimeout. Returns: vpr::ReturnStatus::Succeed is returned if the read operation completed successfully. vpr::ReturnStatus::WouldBlock if the device is in non-blocking mode, and there is no data to read. vpr::ReturnStatus::Timeout is returned if the read could not begin within the timeout interval. vpr::ReturnStatus::Fail is returned if the read operation failed. Definition at line 382 of file SocketImplBSD.cpp. References mBlockingFixed, mHandle, vpr::ReturnStatus::NotConnected, vpr::FileHandleImplUNIX::read_i, and vpr::ReturnStatus::setCode. { vpr::ReturnStatus status; mBlockingFixed = true; status = mHandle->read_i(buffer, length, bytes_read, timeout); if ( bytes_read == 0 ) { status.setCode(vpr::ReturnStatus::NotConnected); } return status; }

vpr::ReturnStatus vpr::SocketImplBSD::readn_i (  void *    buffer, const vpr::Uint32    length, vpr::Uint32 &    bytes_read, const vpr::Interval    timeout = vpr::Interval::NoTimeout )

Implementation of the readn template method. This reads exactly the specified number of bytes from the socket into the given buffer. Precondition: The device is open for reading, and the buffer is at least length bytes long. Postcondition: The given buffer has length bytes copied into it from the device, and the number of bytes read successfully is returned to the caller via the bytes_read parameter. Parameters: buffer  A pointer to the buffer where the device's buffer contents are to be stored. length  The number of bytes to be read. bytes_read  The number of bytes read into the buffer. timeout  The maximum amount of time to wait for data to be available for reading. This argument is optional and defaults to vpr::Interval::NoTimeout Returns: vpr::ReturnStatus::Succeed is returned if the read operation completed successfully. vpr::ReturnStatus::WouldBlock if the device is in non-blocking mode, and there is no data to read. vpr::ReturnStatus::Timeout is returned if the read could not begin within the timeout interval. vpr::ReturnStatus::Fail is returned if the read operation failed. Definition at line 399 of file SocketImplBSD.cpp. References mBlockingFixed, mHandle, vpr::ReturnStatus::NotConnected, vpr::FileHandleImplUNIX::readn_i, and vpr::ReturnStatus::setCode. { vpr::ReturnStatus status; mBlockingFixed = true; status = mHandle->readn_i(buffer, length, bytes_read, timeout); if ( bytes_read == 0 ) { status.setCode(vpr::ReturnStatus::NotConnected); } return status; }

vpr::ReturnStatus vpr::SocketImplBSD::write_i (  const void *    buffer, const vpr::Uint32    length, vpr::Uint32 &    bytes_written, const vpr::Interval    timeout = vpr::Interval::NoTimeout )

Implementation of the write template method. This writes the buffer to the socket. Precondition: The device is open for writing. Postcondition: The given buffer is written to the I/O device, and the number of bytes written successfully is returned to the caller via the bytes_written parameter. Parameters: buffer  A pointer to the buffer to be written. length  The length of the buffer. bytes_written  The number of bytes written to the device. timeout  The maximum amount of time to wait for data to be available for writing. This argument is optional and defaults to vpr::Interval::NoTimeout. Returns: vpr::ReturnStatus::Succeed is returned if the write operation completed successfully. vpr::ReturnStatus::WouldBlock is returned if the handle is in non-blocking mode, and the write operation could not be completed. vpr::ReturnStatus::Timeout is returned if the write could not begin within the timeout interval. vpr::ReturnStatus::Fail is returned if the write operation failed. Definition at line 416 of file SocketImplBSD.cpp. References errno, vpr::ReturnStatus::failure, mBlockingFixed, mHandle, vpr::ReturnStatus::NotConnected, vpr::ReturnStatus::setCode, and vpr::FileHandleImplUNIX::write_i. { vpr::ReturnStatus status; mBlockingFixed = true; status = mHandle->write_i(buffer, length, bytes_written, timeout); if ( status.failure() ) { if ( ECONNRESET == errno || EHOSTUNREACH || EHOSTDOWN || ENETDOWN ) { status.setCode(vpr::ReturnStatus::NotConnected); } } return status; }

vpr::Uint32 vpr::SocketImplBSD::availableBytes (    )  const [inline]

Definition at line 366 of file SocketImplBSD.h. References vpr::FileHandleImplUNIX::availableBytes, and mHandle. { return mHandle->availableBytes(); }

vpr::ReturnStatus vpr::SocketImplBSD::getOption (  const vpr::SocketOptions::Types    option, struct vpr::SocketOptions::Data &    data )  const

Retrieves the value for the given option as set on the socket. Parameters: option  The option to be queried. data  A data buffer that will be used to store the value of the given option. Returns: vpr::ReturnStatus::Succeed is returned if the value for the given option was retrieved successfully. vpr::ReturnStatus;:Fail is returned otherwise. Definition at line 450 of file SocketImplBSD.cpp. References errno, vpr::ReturnStatus::Fail, vpr::FileHandleImplUNIX::getName, vpr::InetAddr, vpr::SocketOptions::Data::ip_ttl, vpr::SocketOptions::Data::keep_alive, vpr::SocketOptions::Data::linger, vpr::SocketOptions::Data::max_segment, vpr::SocketOptions::Data::mcast_if, vpr::SocketOptions::Data::mcast_loopback, vpr::SocketOptions::Data::mcast_ttl, vpr::FileHandleImplUNIX::mFdesc, mHandle, vpr::SocketOptions::Data::no_delay, vpr::SocketOptions::Data::recv_buffer_size, vpr::SocketOptions::Data::reuse_addr, vpr::SocketOptions::Data::send_buffer_size, vpr::ReturnStatus::setCode, and vpr::SocketOptions::Data::type_of_service. { int opt_name, opt_level, status; vpr::ReturnStatus retval; #if defined(VPR_OS_IRIX) || defined(VPR_OS_HPUX) int opt_size; #else socklen_t opt_size; #endif union sockopt_data opt_data; opt_name = opt_level = -1; switch ( option ) { // Socket-level options. case vpr::SocketOptions::Linger: opt_level = SOL_SOCKET; opt_name = SO_LINGER; opt_size = sizeof(opt_data.linger_val); break; case vpr::SocketOptions::ReuseAddr: opt_level = SOL_SOCKET; opt_name = SO_REUSEADDR; opt_size = sizeof(opt_data.enabled); break; case vpr::SocketOptions::KeepAlive: opt_level = SOL_SOCKET; opt_name = SO_KEEPALIVE; opt_size = sizeof(opt_data.enabled); break; case vpr::SocketOptions::RecvBufferSize: opt_level = SOL_SOCKET; opt_name = SO_RCVBUF; opt_size = sizeof(opt_data.size); break; case vpr::SocketOptions::SendBufferSize: opt_level = SOL_SOCKET; opt_name = SO_SNDBUF; opt_size = sizeof(opt_data.size); break; // IP-level options. case vpr::SocketOptions::IpTimeToLive: opt_level = IPPROTO_IP; opt_name = IP_TTL; opt_size = sizeof(opt_data.size); break; case vpr::SocketOptions::IpTypeOfService: opt_level = IPPROTO_IP; opt_name = IP_TOS; opt_size = sizeof(opt_data.size); break; case vpr::SocketOptions::AddMember: opt_level = IPPROTO_IP; opt_name = IP_ADD_MEMBERSHIP; opt_size = sizeof(opt_data.mcast_req); break; case vpr::SocketOptions::DropMember: opt_level = IPPROTO_IP; opt_name = IP_DROP_MEMBERSHIP; opt_size = sizeof(opt_data.mcast_req); break; case vpr::SocketOptions::McastInterface: opt_level = IPPROTO_IP; opt_name = IP_MULTICAST_IF; opt_size = sizeof(opt_data.mcast_if); break; case vpr::SocketOptions::McastTimeToLive: opt_level = IPPROTO_IP; opt_name = IP_MULTICAST_TTL; opt_size = sizeof(opt_data.mcast_ttl); break; case vpr::SocketOptions::McastLoopback: opt_level = IPPROTO_IP; opt_name = IP_MULTICAST_LOOP; opt_size = sizeof(opt_data.mcast_loop); break; // TCP-level options. case vpr::SocketOptions::NoDelay: opt_level = IPPROTO_TCP; opt_name = TCP_NODELAY; opt_size = sizeof(opt_data.enabled); break; case vpr::SocketOptions::MaxSegment: opt_level = IPPROTO_TCP; opt_name = TCP_MAXSEG; opt_size = sizeof(opt_data.size); break; } status = getsockopt(mHandle->mFdesc, opt_level, opt_name, (void*) &opt_data, &opt_size); if ( status == 0 ) { // This extracts the information from the union passed to getsockopt(2) // and puts it in our friendly vpr::SocketOptions::Data object. This // code depends on the type of that object being a union! switch ( option ) { case vpr::SocketOptions::Linger: data.linger.enabled = (opt_data.linger_val.l_onoff != 0 ? true : false); data.linger.seconds = opt_data.linger_val.l_linger; break; case vpr::SocketOptions::ReuseAddr: data.reuse_addr = (opt_data.enabled != 0 ? true : false); break; case vpr::SocketOptions::KeepAlive: data.keep_alive = (opt_data.enabled != 0 ? true : false); break; case vpr::SocketOptions::RecvBufferSize: data.recv_buffer_size = opt_data.size; break; case vpr::SocketOptions::SendBufferSize: data.send_buffer_size = opt_data.size; break; case vpr::SocketOptions::IpTimeToLive: data.ip_ttl = opt_data.size; break; case vpr::SocketOptions::IpTypeOfService: switch ( opt_data.size ) { case IPTOS_LOWDELAY: data.type_of_service = vpr::SocketOptions::LowDelay; break; case IPTOS_THROUGHPUT: data.type_of_service = vpr::SocketOptions::Throughput; break; case IPTOS_RELIABILITY: data.type_of_service = vpr::SocketOptions::Reliability; break; #ifdef IPTOS_LOWCOST case IPTOS_LOWCOST: data.type_of_service = vpr::SocketOptions::LowCost; break; #endif } break; case vpr::SocketOptions::McastInterface: data.mcast_if = InetAddr(); data.mcast_if.setAddress(opt_data.mcast_if.s_addr, 0); break; case vpr::SocketOptions::McastTimeToLive: data.mcast_ttl = opt_data.mcast_ttl; break; case vpr::SocketOptions::McastLoopback: data.mcast_loopback = opt_data.mcast_loop; break; case vpr::SocketOptions::NoDelay: data.no_delay = (opt_data.enabled != 0 ? true : false); break; case vpr::SocketOptions::MaxSegment: data.max_segment = opt_data.size; break; case vpr::SocketOptions::AddMember: case vpr::SocketOptions::DropMember: break; } } else { retval.setCode(vpr::ReturnStatus::Fail); fprintf(stderr, "[vpr::SocketImplBSD] ERROR: Could not get socket option for socket %s: %s\n", mHandle->getName().c_str(), strerror(errno)); } return retval; }

vpr::ReturnStatus vpr::SocketImplBSD::setOption (  const vpr::SocketOptions::Types    option, const struct vpr::SocketOptions::Data &    data )

Do nothing. Parameters: option  The option whose value will be set. data  A data buffer containing the value to be used in setting the socket option. Definition at line 626 of file SocketImplBSD.cpp. References vpr::ReturnStatus::Fail, vpr::SocketOptions::Data::ip_ttl, vpr::SocketOptions::Data::keep_alive, vpr::SocketOptions::Data::linger, vpr::SocketOptions::Data::max_segment, vpr::SocketOptions::Data::mcast_add_member, vpr::SocketOptions::Data::mcast_drop_member, vpr::SocketOptions::Data::mcast_if, vpr::SocketOptions::Data::mcast_loopback, vpr::SocketOptions::Data::mcast_ttl, vpr::FileHandleImplUNIX::mFdesc, mHandle, vpr::SocketOptions::Data::no_delay, vpr::SocketOptions::Data::recv_buffer_size, vpr::SocketOptions::Data::reuse_addr, vpr::SocketOptions::Data::send_buffer_size, and vpr::SocketOptions::Data::type_of_service. { int opt_name, opt_level; #if defined(VPR_OS_IRIX) || defined(VPR_OS_HPUX) int opt_size; #else socklen_t opt_size; #endif union sockopt_data opt_data; vpr::ReturnStatus retval; opt_name = opt_level = -1; opt_size = 0; switch ( option ) { // Socket-level options. case vpr::SocketOptions::Linger: opt_level = SOL_SOCKET; opt_name = SO_LINGER; opt_data.linger_val.l_onoff = (data.linger.enabled ? 1 : 0); opt_data.linger_val.l_linger = data.linger.seconds; opt_size = sizeof(struct linger); break; case vpr::SocketOptions::ReuseAddr: opt_level = SOL_SOCKET; opt_name = SO_REUSEADDR; opt_data.enabled = (data.reuse_addr ? 1 : 0); opt_size = sizeof(int); break; case vpr::SocketOptions::KeepAlive: opt_level = SOL_SOCKET; opt_name = SO_KEEPALIVE; opt_data.enabled = (data.keep_alive ? 1 : 0); opt_size = sizeof(int); break; case vpr::SocketOptions::RecvBufferSize: opt_name = SO_RCVBUF; opt_level = SOL_SOCKET; opt_data.size = data.recv_buffer_size; opt_size = sizeof(size_t); break; case vpr::SocketOptions::SendBufferSize: opt_level = SOL_SOCKET; opt_name = SO_SNDBUF; opt_data.size = data.send_buffer_size; opt_size = sizeof(size_t); break; // IP-level options. case vpr::SocketOptions::IpTimeToLive: opt_level = IPPROTO_IP; opt_name = IP_TTL; opt_data.size = data.ip_ttl; opt_size = sizeof(size_t); break; case vpr::SocketOptions::IpTypeOfService: opt_level = IPPROTO_IP; opt_name = IP_TOS; switch ( data.type_of_service ) { case vpr::SocketOptions::LowDelay: opt_data.size = IPTOS_LOWDELAY; break; case vpr::SocketOptions::Throughput: opt_data.size = IPTOS_THROUGHPUT; break; case vpr::SocketOptions::Reliability: opt_data.size = IPTOS_RELIABILITY; break; case vpr::SocketOptions::LowCost: #ifdef IPTOS_LOWCOST opt_data.size = IPTOS_LOWCOST; #else fprintf(stderr, "[vpr::SocketImplBSD] WARNING: This platform does not " "support LowCost type of service!\n"); #endif break; } opt_size = sizeof(size_t); break; case vpr::SocketOptions::AddMember: opt_level = IPPROTO_IP; opt_name = IP_ADD_MEMBERSHIP; opt_data.mcast_req.imr_multiaddr.s_addr = data.mcast_add_member.getMulticastAddr().getAddressValue(); opt_data.mcast_req.imr_interface.s_addr = data.mcast_add_member.getInterfaceAddr().getAddressValue(); opt_size = sizeof(struct ip_mreq); break; case vpr::SocketOptions::DropMember: opt_level = IPPROTO_IP; opt_name = IP_DROP_MEMBERSHIP; opt_data.mcast_req.imr_multiaddr.s_addr = data.mcast_drop_member.getMulticastAddr().getAddressValue(); opt_data.mcast_req.imr_interface.s_addr = data.mcast_drop_member.getInterfaceAddr().getAddressValue(); opt_size = sizeof(struct ip_mreq); break; case vpr::SocketOptions::McastInterface: opt_level = IPPROTO_IP; opt_name = IP_MULTICAST_IF; opt_data.mcast_if.s_addr = data.mcast_if.getAddressValue(); opt_size = sizeof(struct in_addr); break; case vpr::SocketOptions::McastTimeToLive: opt_level = IPPROTO_IP; opt_name = IP_MULTICAST_TTL; opt_data.mcast_ttl = data.mcast_ttl; opt_size = sizeof(Uint8); break; case vpr::SocketOptions::McastLoopback: opt_level = IPPROTO_IP; opt_name = IP_MULTICAST_LOOP; opt_data.mcast_loop = data.mcast_loopback; opt_size = sizeof(Uint8); break; // TCP-level options. case vpr::SocketOptions::NoDelay: opt_level = IPPROTO_TCP; opt_name = TCP_NODELAY; opt_data.enabled = (data.no_delay ? 1 : 0); opt_size = sizeof(int); break; case vpr::SocketOptions::MaxSegment: opt_level = IPPROTO_TCP; opt_name = TCP_MAXSEG; opt_data.size = data.max_segment; opt_size = sizeof(size_t); break; } if ( ::setsockopt(mHandle->mFdesc, opt_level, opt_name, &opt_data, opt_size) != 0 ) { retval.setCode(vpr::ReturnStatus::Fail); } return retval; }

---

Member Data Documentation

bool vpr::SocketImplBSD::mOpenBlocking [protected]

Used for working around socket(2) semantics. Definition at line 430 of file SocketImplBSD.h. Referenced by open, and setBlocking.

bool vpr::SocketImplBSD::mBound [protected]

Definition at line 431 of file SocketImplBSD.h. Referenced by bind, connect, isBound, and setLocalAddr.

bool vpr::SocketImplBSD::mConnected [protected]

Definition at line 432 of file SocketImplBSD.h. Referenced by connect, isConnected, and setLocalAddr.

bool vpr::SocketImplBSD::mBlockingFixed [protected]

Definition at line 433 of file SocketImplBSD.h. Referenced by vpr::SocketStreamImplBSD::accept, connect, isBlockingFixed, read_i, readn_i, vpr::SocketDatagramImplBSD::recvfrom, vpr::SocketDatagramImplBSD::sendto, setBlocking, and write_i.

vpr::FileHandleImplUNIX* vpr::SocketImplBSD::mHandle [protected]

The OS handle for this socket. Definition at line 435 of file SocketImplBSD.h. Referenced by vpr::SocketStreamImplBSD::accept, availableBytes, bind, close, connect, getHandle, getName, getOption, isBlocking, isConnected, isOpen, vpr::SocketStreamImplBSD::listen, open, read_i, readn_i, vpr::SocketDatagramImplBSD::recvfrom, vpr::SocketDatagramImplBSD::sendto, setBlocking, setOption, vpr::SocketDatagramImplBSD::SocketDatagramImplBSD, SocketImplBSD, vpr::SocketStreamImplBSD::SocketStreamImplBSD, write_i, and ~SocketImplBSD.