vpr::ReturnStatus

vpr::ReturnStatus Class Reference

Class used to represent the status of a function or method upon its return. More...

#include <vpr/Util/ReturnStatus.h>

List of all members.

Public Types

enum  Code {
  Succeed, Fail, WouldBlock, Timeout,
  InProgress, NotConnected, ConnectionAborted
}
 Possible status codes. More...

Public Member Functions

 ReturnStatus ()
 Default constructor.
void copy (const ReturnStatus &status)
 Copies the given object into this object.
void setCode (const Code &c)
 Sets the status code.
const Code & code () const
 Gets status code.
 ReturnStatus (const ReturnStatus &status)
 Copy constructor.
 ReturnStatus (const Code &c)
 vpr::ReturnStatus::Code constructor.
ReturnStatus & operator= (const ReturnStatus &status)
 Assignment operator for vpr::ReturnStatus objects.
ReturnStatus & operator= (const Code &c)
 Assignment operator for vpr::ReturnStatus::Code values.
bool operator== (const ReturnStatus &status) const
 Equality operator for comparison with a vpr::ReturnStatus object.
bool operator== (const Code &c) const
 Equality operator for comparison with a vpr::ReturnStatus::Code value.
bool operator!= (const ReturnStatus &status) const
 Inequality operator for comparison with a vpr::ReturnStatus object.
bool operator!= (const Code &c) const
 Inequality operator for comparison with a vpr::ReturnStatus::Code values.
State test helpers
bool success () const
bool failure () const
bool wouldBlock () const
bool inProgress () const
bool timeout () const
bool connectionAborted () const
 
Since:
1.0.2

Detailed Description

Class used to represent the status of a function or method upon its return.

Definition at line 56 of file ReturnStatus.h.

Member Enumeration Documentation

enum vpr::ReturnStatus::Code

Possible status codes.

Enumerator:
Succeed  Successful status.
Fail  Failure status.
WouldBlock  Operation would block.
Timeout  Timeout occurred.
InProgress  Operation is still in progress.
NotConnected  The given I/O device is closed.
ConnectionAborted  Connection was aborted.

Definition at line 60 of file ReturnStatus.h.

00061       {
00062          Succeed,          
00063          Fail,             
00064          WouldBlock,       
00065          Timeout,          
00066          InProgress,       
00067          NotConnected,     
00068          ConnectionAborted 
00069       };

Constructor & Destructor Documentation

vpr::ReturnStatus::ReturnStatus (  )  [inline]

Default constructor.

vpr::ReturnStatus::Succeed is default.

Definition at line 72 of file ReturnStatus.h.

00072                      : mReturnStatus(vpr::ReturnStatus::Succeed)
00073       {
00074       }

vpr::ReturnStatus::ReturnStatus ( const ReturnStatus &  status  )  [inline]

Copy constructor.

Definition at line 107 of file ReturnStatus.h.

References copy().

00108       {
00109          this->copy(status);
00110       }

vpr::ReturnStatus::ReturnStatus ( const Code &  c  )  [inline]

vpr::ReturnStatus::Code constructor.

Definition at line 113 of file ReturnStatus.h.

References setCode().

00114       {
00115          this->setCode(c);
00116       }

Member Function Documentation

void vpr::ReturnStatus::copy ( const ReturnStatus &  status  )  [inline]

Copies the given object into this object.

Postcondition:
This object is a copy of status.
Parameters:
status The vpr::ReturnStatus object to be copied.

Definition at line 83 of file ReturnStatus.h.

References mReturnStatus.

Referenced by operator=(), and ReturnStatus().

00084       {
00085          mReturnStatus = status.mReturnStatus;
00086       }

void vpr::ReturnStatus::setCode ( const Code &  c  )  [inline]

Sets the status code.

Postcondition:
Set status to c.

Definition at line 93 of file ReturnStatus.h.

Referenced by vpr::SocketStreamImplSIM::accept(), vpr::SocketStreamImplNSPR::accept(), vpr::SocketStreamImplBSD::accept(), vpr::SemaphoreSGI::acquire(), vpr::SignalSet::addSignal(), vpr::SocketImplNSPR::bind(), vpr::SocketImplBSD::bind(), vpr::CondVarNSPR::broadcast(), vpr::SocketImplNSPR::close(), vpr::SerialPortImplWin32::close(), vpr::FileHandleImplUNIX::close(), vpr::sim::SocketManager::connect(), vpr::SocketImplNSPR::connect(), vpr::SocketImplBSD::connect(), vpr::sim::NetworkGraph::construct(), vpr::SerialPortImplTermios::controlFlow(), vpr::SerialPortImplTermios::drainOutput(), vpr::SignalSet::emptySet(), vpr::SignalSet::fillSet(), vpr::SerialPortImplTermios::flushQueue(), vpr::SerialPortImplTermios::getAttrs(), vpr::SerialPortImplWin32::getCharacterSize(), vpr::SystemPosix::getenv(), vpr::SystemNSPR::getenv(), vpr::InetAddrNSPR::getHostname(), vpr::InetAddrBSD::getHostname(), vpr::InetAddrNSPR::getLocalHost(), vpr::InetAddrBSD::getLocalHost(), vpr::SerialPortImplWin32::getMinInputSize(), vpr::sim::NetworkGraph::getNodeWithAddr(), vpr::SocketImplSIM::getOption(), vpr::SocketImplNSPR::getOption(), vpr::SocketImplBSD::getOption(), vpr::FileHandleImplUNIX::getReadBufferSize(), vpr::SerialPortImplWin32::getStopBits(), vpr::SerialPortImplWin32::getTimeout(), vpr::FileHandleImplUNIX::isReadable(), vpr::SocketStreamImplSIM::isReadReady(), vpr::SocketDatagramImplSIM::isReadReady(), vpr::FileHandleImplUNIX::isWriteable(), vpr::SocketStreamImplSIM::isWriteReady(), vpr::SocketDatagramImplSIM::isWriteReady(), vpr::SocketStreamImplNSPR::listen(), vpr::SocketStreamImplBSD::listen(), vpr::LibraryUNIX::load(), vpr::LibraryNSPR::load(), vpr::LibraryDYLD::load(), vpr::InetAddrNSPR::lookupAddress(), vpr::InetAddrBSD::lookupAddress(), vpr::SocketImplNSPR::open(), vpr::SocketImplBSD::open(), vpr::SerialPortImplWin32::open(), vpr::FileHandleImplUNIX::open(), operator=(), vpr::SocketImplNSPR::read_i(), vpr::SocketImplBSD::read_i(), vpr::SerialPortImplWin32::read_i(), vpr::FileHandleImplUNIX::read_i(), vpr::SocketImplNSPR::readn_i(), vpr::SocketImplBSD::readn_i(), vpr::FileHandleImplUNIX::readn_i(), vpr::SocketDatagramImplSIM::recvfrom(), vpr::SocketDatagramImplNSPR::recvfrom(), vpr::SocketDatagramImplBSD::recvfrom(), vpr::SigHandler::registerHandler(), vpr::SemaphoreSGI::release(), vpr::SignalSet::removeSignal(), vpr::sim::NetworkNode::removeSocket(), vpr::SemaphorePosix::reset(), ReturnStatus(), vpr::SelectorImplSIM::select(), vpr::SelectorImplNSPR::select(), vpr::SelectorImplBSD::select(), vpr::SerialPortImplTermios::sendBreak(), vpr::SocketDatagramImplNSPR::sendto(), vpr::SocketDatagramImplBSD::sendto(), vpr::FileHandleImplUNIX::setAppend(), vpr::SerialPortImplTermios::setAttrs(), vpr::SerialPortImplWin32::setBadByteIgnore(), vpr::SocketImplNSPR::setBlocking(), vpr::SocketImplBSD::setBlocking(), vpr::SerialPortImplWin32::setBlocking(), vpr::FileHandleImplUNIX::setBlocking(), vpr::SerialPortImplWin32::setCharacterSize(), vpr::SerialPortImplWin32::setDataTerminalReady(), vpr::SystemPosix::setenv(), vpr::SystemNSPR::setenv(), vpr::SerialPortImplWin32::setInputBaudRate(), vpr::SerialPortImplWin32::setInputParityCheck(), vpr::SocketImplSIM::setLocalAddr(), vpr::SocketImplNSPR::setLocalAddr(), vpr::SocketImplBSD::setLocalAddr(), vpr::SerialPortImplWin32::setMinInputSize(), vpr::SocketImplSIM::setOption(), vpr::SerialPortImplWin32::setOutputBaudRate(), vpr::SerialPortImplWin32::setParityErrorMarking(), vpr::SerialPortImplWin32::setParityGeneration(), vpr::SocketImplSIM::setRemoteAddr(), vpr::SocketImplNSPR::setRemoteAddr(), vpr::SocketImplBSD::setRemoteAddr(), vpr::SerialPortImplWin32::setRequestToSend(), vpr::SerialPortImplWin32::setStopBits(), vpr::FileHandleImplUNIX::setSynchronousWrite(), vpr::SerialPortImplWin32::setTimeout(), vpr::CondVarNSPR::signal(), vpr::ThreadPosix::spawn(), vpr::ThreadSGI::start(), vpr::ThreadPosix::start(), vpr::ThreadNSPR::start(), vpr::LibraryUNIX::unload(), vpr::LibraryNSPR::unload(), vpr::LibraryDYLD::unload(), vpr::CondVarPosix::wait(), vpr::CondVarNSPR::wait(), vpr::SocketImplSIM::write_i(), vpr::SocketImplNSPR::write_i(), vpr::SocketImplBSD::write_i(), vpr::SerialPortImplWin32::write_i(), and vpr::FileHandleImplUNIX::write_i().

00094       {
00095          mReturnStatus = c;
00096       }

const Code& vpr::ReturnStatus::code (  )  const [inline]

Gets status code.

Definition at line 101 of file ReturnStatus.h.

Referenced by operator<<().

00102       {
00103          return mReturnStatus;
00104       }

ReturnStatus& vpr::ReturnStatus::operator= ( const ReturnStatus &  status  )  [inline]

Assignment operator for vpr::ReturnStatus objects.

Postcondition:
This object is a copy of status.

Definition at line 123 of file ReturnStatus.h.

References copy().

00124       {
00125          if((&status) != this)
00126          {
00127             this->copy( status );
00128          }
00129          return *this;
00130       }

ReturnStatus& vpr::ReturnStatus::operator= ( const Code &  c  )  [inline]

Assignment operator for vpr::ReturnStatus::Code values.

Postcondition:
this->mReturnStatus == c.

Definition at line 137 of file ReturnStatus.h.

References setCode().

00138       {
00139          this->setCode(c);
00140          return *this;
00141       }

bool vpr::ReturnStatus::operator== ( const ReturnStatus &  status  )  const [inline]

Equality operator for comparison with a vpr::ReturnStatus object.

Returns:
true if equal, false if not.

Definition at line 148 of file ReturnStatus.h.

References mReturnStatus.

00149       {
00150          return status.mReturnStatus == mReturnStatus;
00151       }

bool vpr::ReturnStatus::operator== ( const Code &  c  )  const [inline]

Equality operator for comparison with a vpr::ReturnStatus::Code value.

Returns:
true if equal, false if not.

Definition at line 158 of file ReturnStatus.h.

00159       {
00160          return c == mReturnStatus;
00161       }

bool vpr::ReturnStatus::operator!= ( const ReturnStatus &  status  )  const [inline]

Inequality operator for comparison with a vpr::ReturnStatus object.

Returns:
false if equal, true if not.

Definition at line 168 of file ReturnStatus.h.

References mReturnStatus.

00169       {
00170          return status.mReturnStatus != mReturnStatus;
00171       }

bool vpr::ReturnStatus::operator!= ( const Code &  c  )  const [inline]

Inequality operator for comparison with a vpr::ReturnStatus::Code values.

Returns:
false if equal, true if not.

Definition at line 179 of file ReturnStatus.h.

00180       {
00181          return c != mReturnStatus;
00182       }

bool vpr::ReturnStatus::success (  )  const [inline]

Definition at line 187 of file ReturnStatus.h.

References Succeed.

Referenced by vpr::SocketStreamImplBSD::accept(), vpr::WriteGuard::acquire(), vpr::ReadGuard::acquire(), vpr::Guard< LOCK_TYPE >::acquire(), vpr::sim::SocketManager::assignToNode(), vpr::SocketImplSIM::bind(), vpr::CondVarNSPR::broadcast(), vpr::SocketConnector::checkOpen(), vpr::SocketImplBSD::connect(), vpr::SocketConnector::connectStart(), vpr::sim::Controller::constructNetwork(), vpr::sim::SocketManager::ensureNetworkNodeIsRegistered(), vpr::SocketBasicOpt::getKeepAlive(), vpr::SocketBasicOpt::getLingerOnClose(), vpr::SocketStreamOpt::getMaxSegmentSize(), vpr::SocketDatagramOpt::getMcastInterface(), vpr::SocketDatagramOpt::getMcastLoopback(), vpr::SocketDatagramOpt::getMcastTimeToLive(), vpr::SocketStreamOpt::getNoDelay(), vpr::SocketBasicOpt::getRecvBufferSize(), vpr::SocketBasicOpt::getReuseAddr(), vpr::SocketBasicOpt::getSendBufferSize(), vpr::SocketIpOpt::getTimeToLive(), vpr::SocketIpOpt::getTypeOfService(), vpr::Guard< LOCK_TYPE >::Guard(), vpr::SocketImplBSD::isConnected(), vpr::LibraryNSPR::load(), vpr::SocketStream_t< SocketConfig_ >::openServer(), vpr::sim::Controller::processNextEvent(), vpr::FileHandleImplUNIX::read_i(), vpr::BandwidthIOStatsStrategy::read_s(), vpr::ReadGuard::ReadGuard(), vpr::BandwidthIOStatsStrategy::readn_s(), vpr::SocketDatagramImplBSD::recvfrom(), vpr::SocketDatagramImplBSD::sendto(), vpr::CondVarNSPR::signal(), vpr::ThreadPosix::start(), vpr::WriteGuard::tryAcquire(), vpr::ReadGuard::tryAcquire(), vpr::Guard< LOCK_TYPE >::tryAcquire(), vpr::sim::SocketManager::unassignFromNode(), vpr::CondVarNSPR::wait(), vpr::FileHandleImplUNIX::write_i(), vpr::BandwidthIOStatsStrategy::write_s(), vpr::WriteGuard::WriteGuard(), and vpr::SocketImplNSPR::~SocketImplNSPR().

00188       {
00189          return mReturnStatus == vpr::ReturnStatus::Succeed;
00190       }

bool vpr::ReturnStatus::failure (  )  const [inline]

Definition at line 192 of file ReturnStatus.h.

References Fail.

Referenced by vpr::sim::SocketManager::connect(), vpr::InetAddrNSPR::lookupAddress(), vpr::SocketAcceptor::open(), and vpr::SocketImplBSD::write_i().

00193       {
00194          return mReturnStatus == vpr::ReturnStatus::Fail;
00195       }

bool vpr::ReturnStatus::wouldBlock (  )  const [inline]

Definition at line 197 of file ReturnStatus.h.

References WouldBlock.

00198       {
00199          return mReturnStatus == vpr::ReturnStatus::WouldBlock;
00200       }

bool vpr::ReturnStatus::inProgress (  )  const [inline]

Definition at line 202 of file ReturnStatus.h.

References InProgress.

00203       {
00204          return mReturnStatus == vpr::ReturnStatus::InProgress;
00205       }

bool vpr::ReturnStatus::timeout (  )  const [inline]

Definition at line 207 of file ReturnStatus.h.

References Timeout.

00208       {
00209          return mReturnStatus == vpr::ReturnStatus::Timeout;
00210       }

bool vpr::ReturnStatus::connectionAborted (  )  const [inline]

Since:
1.0.2

Definition at line 215 of file ReturnStatus.h.

References ConnectionAborted.

00216       {
00217          return mReturnStatus == vpr::ReturnStatus::ConnectionAborted;
00218       }

The documentation for this class was generated from the following file:
Generated on Thu Jan 4 10:56:07 2007 for VR Juggler Portable Runtime by  doxygen 1.5.1