Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::TimeoutException Class Reference

Exception when a timeout occurs. More...

#include </__w/arcaneframework.github.io/arcaneframework.github.io/framework/arccore/src/base/arccore/base/TimeoutException.h>

Inheritance diagram for Arcane::TimeoutException:
Collaboration diagram for Arcane::TimeoutException:

Public Member Functions

 TimeoutException (const String &where)
 TimeoutException (const String &where, const StackTrace &stack_trace)
 TimeoutException (const TimeoutException &ex)
virtual void explain (std::ostream &m) const
 Explains the cause of the exception in the stream o.
Public Member Functions inherited from Arcane::Exception
Exceptionoperator= (const Exception &)=delete
 Exception (const String &name, const String &where)
 Exception (const String &name, const TraceInfo &where)
 Exception (const String &name, const String &awhere, const String &message)
 Exception (const String &name, const TraceInfo &trace, const String &message)
 Exception (const String &name, const String &where, const StackTrace &stack_trace)
 Exception (const String &name, const TraceInfo &where, const StackTrace &stack_trace)
 Exception (const String &name, const String &where, const String &message, const StackTrace &stack_trace)
 Exception (const String &name, const TraceInfo &trace, const String &message, const StackTrace &stack_trace)
 Exception (const Exception &)
 Copy constructor.
 ~Exception () ARCCORE_NOEXCEPT override
 Releases resources.
virtual void write (std::ostream &o) const
bool isCollective () const
 True if it is a collective error (concerns all processors).
void setCollective (bool v)
 Sets the collective state of the expression.
void setAdditionalInfo (const String &v)
 Sets the additional information.
const StringadditionalInfo () const
 Returns the additional information.
const StackTracestackTrace () const
 Call stack at the moment of the exception (requires a stacktrace service).
const StringstackTraceString () const
 Call stack at the moment of the exception (requires a stacktrace service).
const Stringmessage () const
 Exception message.
const Stringwhere () const
 Location of the exception.
const Stringname () const
 Name of the exception.

Additional Inherited Members

Static Public Member Functions inherited from Arcane::Exception
static bool hasPendingException ()
 Indicates if there are pending exceptions.
static void staticInit ()
Protected Member Functions inherited from Arcane::Exception
void setMessage (const String &msg)
 Sets the exception message.

Detailed Description

Exception when a timeout occurs.

Definition at line 32 of file arccore/src/base/arccore/base/TimeoutException.h.

Constructor & Destructor Documentation

◆ TimeoutException() [1/3]

Arcane::TimeoutException::TimeoutException ( const String & where)

Definition at line 25 of file TimeoutException.cc.

◆ TimeoutException() [2/3]

Arcane::TimeoutException::TimeoutException ( const String & where,
const StackTrace & stack_trace )

Definition at line 34 of file TimeoutException.cc.

◆ TimeoutException() [3/3]

Arcane::TimeoutException::TimeoutException ( const TimeoutException & ex)
inline

◆ ~TimeoutException()

Arcane::TimeoutException::~TimeoutException ( )
inline

Member Function Documentation

◆ explain()

void Arcane::TimeoutException::explain ( std::ostream & o) const
virtual

Explains the cause of the exception in the stream o.

This method allows adding additional information to the exception message.

Reimplemented from Arcane::Exception.

Definition at line 43 of file TimeoutException.cc.


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