Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages   Examples  

vpr::ReturnStatus Class Reference

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

#include <ReturnStatus.h>

List of all members.

Public Types

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


Public Methods

 ReturnStatus ()
 Default constructor. vpr::ReturnStatus:;Succeed is default. More...

void copy (const ReturnStatus &status)
 Copies the given object into this object. More...

void setCode (const Code &c)
 Sets the status code. More...

const Code & code () const
 Gets status code. More...

 ReturnStatus (const ReturnStatus &status)
 copy constructor. More...

 ReturnStatus (const Code &c)
 ReturnStatus::Code constructor. More...

ReturnStatus & operator= (const ReturnStatus &status)
 operator=. More...

ReturnStatus & operator= (const Code &c)
 operator=. More...

bool operator== (const ReturnStatus &status) const
 operator==. More...

bool operator== (const Code &c) const
 operator==. More...

bool operator!= (const ReturnStatus &status) const
 operator!=. More...

bool operator!= (const Code &c) const
 operator!=. More...

bool success () const
bool failure () const
bool wouldBlock () const
bool inProgress () const
bool timeout () const

Detailed Description

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

Definition at line 54 of file ReturnStatus.h.

Member Enumeration Documentation

enum vpr::ReturnStatus::Code
 

Possible status codes.

Enumeration values:
Succeed  Succeedful status.
Fail  Fail status.
WouldBlock  Operation would block.
Timeout  Timeout occurred.
InProgress  Operation is still in progress.
NotConnected  The given IO device is closed.

Definition at line 58 of file ReturnStatus.h. 

00059       {
00060          Succeed,          
00061          Fail,             
00062          WouldBlock,       
00063          Timeout,          
00064          InProgress,       
00065          NotConnected      
00066       };

Constructor & Destructor Documentation

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

Default constructor. vpr::ReturnStatus:;Succeed is default.

Definition at line 69 of file ReturnStatus.h. 

00069                      : mReturnStatus( vpr::ReturnStatus::Succeed )
00070       {
00071       }

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

copy constructor.

Definition at line 104 of file ReturnStatus.h. 

00105       {
00106          this->copy( status );
00107       }

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

ReturnStatus::Code constructor.

Definition at line 110 of file ReturnStatus.h. 

00111       {
00112          this->setCode(c);
00113       }

Member Function Documentation

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

Copies the given object into this object.

Postcondition:
this = status
Parameters:
status  The vpr::ReturnStatus object to be copied.

Definition at line 80 of file ReturnStatus.h. 

00081       {
00082          mReturnStatus = status.mReturnStatus;
00083       }

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

Sets the status code.

Postcondition:
Set status to code.

Definition at line 90 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::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::LibraryLoader::loadAndInitDSO, vpr::InetAddrNSPR::lookupAddress, vpr::InetAddrBSD::lookupAddress, vpr::SocketImplNSPR::open, vpr::SocketImplBSD::open, vpr::SerialPortImplWin32::open, vpr::FileHandleImplUNIX::open, 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::SocketDatagramImplBSD::recvfrom, vpr::SigHandler::registerHandler, vpr::SemaphoreSGI::release, vpr::SignalSet::removeSignal, vpr::sim::NetworkNode::removeSocket, vpr::SelectorImplSIM::select, vpr::SelectorImplNSPR::select, vpr::SelectorImplBSD::select, vpr::SerialPortImplTermios::sendBreak, 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::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::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::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. 

00091       {
00092          mReturnStatus = c;
00093       }

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

Gets status code.

Definition at line 98 of file ReturnStatus.h. 

00099       {
00100          return mReturnStatus;
00101       }

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

operator=.

Postcondition:
this = status

Definition at line 120 of file ReturnStatus.h. 

00121       {
00122          if((&status) != this)
00123          {
00124             this->copy( status );
00125          }
00126          return *this;
00127       }

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

operator=.

Postcondition:
this = status

Definition at line 134 of file ReturnStatus.h. 

00135       {
00136          this->setCode(c);
00137          return *this;
00138       }

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

operator==.

Returns:
true if equal, false if not

Definition at line 145 of file ReturnStatus.h. 

00146       {
00147          return status.mReturnStatus == mReturnStatus;
00148       }

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

operator==.

Returns:
true if equal, false if not

Definition at line 155 of file ReturnStatus.h. 

00156       {
00157          return c == mReturnStatus;
00158       }

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

operator!=.

Returns:
false if equal, true if not

Definition at line 165 of file ReturnStatus.h. 

00166       {
00167          return status.mReturnStatus != mReturnStatus;
00168       }

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

operator!=.

Returns:
false if equal, true if not

Definition at line 175 of file ReturnStatus.h. 

00176       {
00177          return c != mReturnStatus;
00178       }

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

Definition at line 181 of file ReturnStatus.h.

References Succeed.

Referenced by vpr::SocketStreamImplBSD::accept, vpr::sim::SocketManager::assignToNode, vpr::SocketImplSIM::bind, vpr::CondVarNSPR::broadcast, vpr::SocketConnector::checkOpen, vpr::SocketImplBSD::connect, vpr::sim::Controller::constructNetwork, vpr::sim::SocketManager::ensureNetworkNodeIsRegistered, vpr::SerialPortImplTermios::getBit, vpr::SerialPortImplTermios::getControlCharacter, 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::Guard, vpr::SocketImplBSD::isConnected, vpr::LibraryNSPR::load, vpr::LibraryLoader::loadAndInitDSO, vpr::SocketStream_t< SocketConfiguration >::openServer, vpr::sim::Controller::processNextEvent, vpr::BlockIO::read, vpr::FileHandleImplUNIX::read_i, vpr::ReadGuard::ReadGuard, vpr::BlockIO::readn, vpr::SocketDatagramImplBSD::recvfrom, vpr::SocketDatagram_t::recvfrom, vpr::sim::SocketManager::sendMessageTo, vpr::SocketDatagramImplBSD::sendto, vpr::SerialPortImplTermios::setControlCharacter, vpr::CondVarNSPR::signal, vpr::ThreadSGI::start, vpr::ThreadPosix::start, vpr::sim::SocketManager::unassignFromNode, vpr::LibraryLoader::unloadDSO, vpr::CondVarNSPR::wait, vpr::FileHandleImplUNIX::write_i, vpr::WriteGuard::WriteGuard, and vpr::SocketImplNSPR::~SocketImplNSPR. 

00181 { return mReturnStatus == vpr::ReturnStatus::Succeed; }

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

Definition at line 182 of file ReturnStatus.h.

References Fail.

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

00182 { return mReturnStatus == vpr::ReturnStatus::Fail; }

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

Definition at line 183 of file ReturnStatus.h.

References WouldBlock. 

00183 { return mReturnStatus == vpr::ReturnStatus::WouldBlock; }

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

Definition at line 184 of file ReturnStatus.h.

References InProgress. 

00184 { return mReturnStatus == vpr::ReturnStatus::InProgress; }

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

Definition at line 185 of file ReturnStatus.h.

References Timeout. 

00185 { return mReturnStatus == vpr::ReturnStatus::Timeout; }

The documentation for this class was generated from the following file:
Generated on Sun May 2 14:47:17 2004 for VR Juggler Portable Runtime by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002