wrench::NetworkError Class Reference

A "network error (or endpoint is down)" failure cause. More...

#include <FailureCause.h>

Inheritance diagram for wrench::NetworkError:
wrench::FailureCause

Public Types

enum  ErrorType { TIMEOUT, FAILURE }
 Enumerated type to describe the type of the network error.
 
enum  OperationType { SENDING, RECEIVING }
 Enumerated type to describe whether the network error occured while sending or receiving.
 
- Public Types inherited from wrench::FailureCause
enum  CauseType {
  FATAL_FAILURE, NO_STORAGE_SERVICE_FOR_FILE, NO_SCRATCH_SPACE, FILE_NOT_FOUND,
  FILE_ALREADY_THERE, FILE_ALREADY_BEING_COPIED, STORAGE_NOT_ENOUGH_SPACE, SERVICE_DOWN,
  JOB_TYPE_NOT_SUPPORTED, NOT_ENOUGH_RESOURCES, NETWORK_ERROR, NETWORK_TIMEOUT,
  JOB_KILLED, JOB_CANNOT_BE_TERMINATED, JOB_CANNOT_BE_FORGOTTEN, COMPUTE_THREAD_HAS_DIED,
  FUNCTIONALITY_NOT_AVAILABLE, JOB_TIMEOUT, HOST_ERROR
}
 Types of failure causes. More...
 

Public Member Functions

std::string getMailbox ()
 Returns the mailbox name on which the error occurred. More...
 
bool isTimeout ()
 Returns whether the network error was a timeout. More...
 
std::string toString ()
 Get the human-readable failure message. More...
 
bool whileReceiving ()
 Returns whether the network error occurred while receiving. More...
 
bool whileSending ()
 Returns whether the network error occurred while sending. More...
 
- Public Member Functions inherited from wrench::FailureCause
 FailureCause (CauseType cause)
 Constructor. More...
 
CauseType getCauseType ()
 Retrieve the type of the failure cause. More...
 

Detailed Description

A "network error (or endpoint is down)" failure cause.

Member Function Documentation

◆ getMailbox()

std::string wrench::NetworkError::getMailbox ( )

Returns the mailbox name on which the error occurred.

Returns
the mailbox name

◆ isTimeout()

bool wrench::NetworkError::isTimeout ( )

Returns whether the network error was a timeout.

Returns
true or false

◆ toString()

std::string wrench::NetworkError::toString ( )
virtual

Get the human-readable failure message.

Returns
the message

Implements wrench::FailureCause.

◆ whileReceiving()

bool wrench::NetworkError::whileReceiving ( )

Returns whether the network error occurred while receiving.

Returns
true or false

◆ whileSending()

bool wrench::NetworkError::whileSending ( )

Returns whether the network error occurred while sending.

Returns
true or false

The documentation for this class was generated from the following files:
  • /Users/rafsilva/Documents/isi/workspace/wrench/wrench/include/wrench/workflow/execution_events/FailureCause.h
  • /Users/rafsilva/Documents/isi/workspace/wrench/wrench/src/wrench/workflow/execution_events/FailureCause.cpp