Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
ICheckpointMng.h
1// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
2//-----------------------------------------------------------------------------
3// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
4// See the top-level COPYRIGHT file for details.
5// SPDX-License-Identifier: Apache-2.0
6//-----------------------------------------------------------------------------
7/*---------------------------------------------------------------------------*/
8/* ICheckpointMng.h (C) 2000-2025 */
9/* */
10/* Interface of the checkpoint information manager. */
11/*---------------------------------------------------------------------------*/
12#ifndef ARCANE_CORE_ICHECKPOINTMNG_H
13#define ARCANE_CORE_ICHECKPOINTMNG_H
14/*---------------------------------------------------------------------------*/
15/*---------------------------------------------------------------------------*/
16
18
19/*---------------------------------------------------------------------------*/
20/*---------------------------------------------------------------------------*/
21
22namespace Arcane
23{
24
25/*---------------------------------------------------------------------------*/
26/*---------------------------------------------------------------------------*/
27
38class ARCANE_CORE_EXPORT ICheckpointMng
39{
40 public:
41
42 virtual ~ICheckpointMng() = default;
43
44 public:
45
53 ARCANE_DEPRECATED_122 virtual void readCheckpoint() = 0;
54
60 virtual void readCheckpoint(ICheckpointReader* reader) = 0;
61
75 virtual ARCANE_DEPRECATED_2018 void readCheckpoint(ByteConstArrayView infos) = 0;
76
83 virtual CheckpointInfo readCheckpointInfo(Span<const Byte> infos, const String& buf_name) = 0;
84
90 virtual void readCheckpoint(const CheckpointInfo& checkpoint_info) = 0;
91
108 virtual ARCANE_DEPRECATED_2018 void readDefaultCheckpoint() = 0;
109
123
131 ARCANE_DEPRECATED_122 virtual void writeCheckpoint(ICheckpointWriter* writer) = 0;
132
145 virtual void writeCheckpoint(ICheckpointWriter* writer, ByteArray& infos) = 0;
146
156 virtual void writeDefaultCheckpoint(ICheckpointWriter* writer) = 0;
157
164
171};
172
173/*---------------------------------------------------------------------------*/
174/*---------------------------------------------------------------------------*/
175
176} // namespace Arcane
177
178/*---------------------------------------------------------------------------*/
179/*---------------------------------------------------------------------------*/
180
181#endif
Declarations of Arcane's general types.
Information about a checkpoint.
Interface of the checkpoint information manager.
virtual IObservable * writeObservable()=0
Write observable.
virtual ARCANE_DEPRECATED_2018 void readCheckpoint(ByteConstArrayView infos)=0
Reads a checkpoint.
virtual ~ICheckpointMng()=default
Frees resources.
virtual ARCANE_DEPRECATED_122 void readCheckpoint()=0
Reads a checkpoint.
virtual CheckpointInfo readCheckpointInfo(Span< const Byte > infos, const String &buf_name)=0
Reads checkpoint information.
virtual ARCANE_DEPRECATED_2018 void readDefaultCheckpoint()=0
Reads a default checkpoint.
virtual ARCANE_DEPRECATED_122 void writeCheckpoint(ICheckpointWriter *writer)=0
Writes a default checkpoint using the writer.
virtual void readCheckpoint(const CheckpointInfo &checkpoint_info)=0
Reads a checkpoint.
virtual void readCheckpoint(ICheckpointReader *reader)=0
Reads a checkpoint.
virtual CheckpointInfo readDefaultCheckpointInfo()=0
Reads default checkpoint information.
virtual IObservable * readObservable()=0
Read observable.
virtual void writeDefaultCheckpoint(ICheckpointWriter *writer)=0
Writes a checkpoint using the writer.
virtual void writeCheckpoint(ICheckpointWriter *writer, ByteArray &infos)=0
Writes a checkpoint using the writer.
Interface for the protection/recovery reading service.
Interface of the checkpoint/recovery write service.
View of an array of elements of type T.
Definition Span.h:635
-- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature --
Array< Byte > ByteArray
Dynamic one-dimensional array of characters.
Definition UtilsTypes.h:121
ConstArrayView< Byte > ByteConstArrayView
C equivalent of a 1D array of characters.
Definition UtilsTypes.h:476