Scippy

SCIP

Solving Constraint Integer Programs

interrupt.h
Go to the documentation of this file.
1 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2 /* */
3 /* This file is part of the program and library */
4 /* SCIP --- Solving Constraint Integer Programs */
5 /* */
6 /* Copyright (c) 2002-2023 Zuse Institute Berlin (ZIB) */
7 /* */
8 /* Licensed under the Apache License, Version 2.0 (the "License"); */
9 /* you may not use this file except in compliance with the License. */
10 /* You may obtain a copy of the License at */
11 /* */
12 /* http://www.apache.org/licenses/LICENSE-2.0 */
13 /* */
14 /* Unless required by applicable law or agreed to in writing, software */
15 /* distributed under the License is distributed on an "AS IS" BASIS, */
16 /* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
17 /* See the License for the specific language governing permissions and */
18 /* limitations under the License. */
19 /* */
20 /* You should have received a copy of the Apache-2.0 license */
21 /* along with SCIP; see the file LICENSE. If not visit scipopt.org. */
22 /* */
23 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
24 
25 /**@file interrupt.h
26  * @ingroup INTERNALAPI
27  * @brief methods for catching the user CTRL-C interrupt
28  * @author Tobias Achterberg
29  */
30 
31 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
32 
33 #ifndef __SCIP_INTERRUPT_H__
34 #define __SCIP_INTERRUPT_H__
35 
36 
37 #include "scip/def.h"
38 #include "scip/type_retcode.h"
39 #include "scip/type_interrupt.h"
40 
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44 
45 /** creates a CTRL-C interrupt data */
47  SCIP_INTERRUPT** interrupt /**< pointer to store the CTRL-C interrupt data */
48  );
49 
50 /** frees a CTRL-C interrupt data */
52  SCIP_INTERRUPT** interrupt /**< pointer to the CTRL-C interrupt data */
53  );
54 
55 /** captures the CTRL-C interrupt to call the SCIP's own interrupt handler */
57  SCIP_INTERRUPT* interrupt /**< CTRL-C interrupt data */
58  );
59 
60 /** releases the CTRL-C interrupt and restores the old interrupt handler */
62  SCIP_INTERRUPT* interrupt /**< CTRL-C interrupt data */
63  );
64 
65 /** returns whether the user interrupted by pressing CTRL-C */
67  void
68  );
69 
70 /** returns whether the process has received a SIGTERM */
72  void
73  );
74 
75 /** sends a termination signal to all SCIP processes so that they try to terminate as soon as possible
76  *
77  * @note For terminating a specific SCIP process use SCIPinterruptSolve().
78  */
79 void SCIPtryTerminate(
80  void
81  );
82 
83 /** resets the number of interrupts to 0 */
85  void
86  );
87 
88 #ifdef __cplusplus
89 }
90 #endif
91 
92 #endif
void SCIPtryTerminate(void)
Definition: interrupt.c:182
SCIP_RETCODE SCIPinterruptCreate(SCIP_INTERRUPT **interrupt)
Definition: interrupt.c:91
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:63
type definitions for return codes for SCIP methods
void SCIPresetInterrupted(void)
Definition: interrupt.c:190
SCIP_Bool SCIPterminated(void)
Definition: interrupt.c:171
void SCIPinterruptRelease(SCIP_INTERRUPT *interrupt)
Definition: interrupt.c:144
#define SCIP_Bool
Definition: def.h:93
SCIP_Bool SCIPinterrupted(void)
Definition: interrupt.c:163
void SCIPinterruptFree(SCIP_INTERRUPT **interrupt)
Definition: interrupt.c:104
common defines and data types used in all packages of SCIP
void SCIPinterruptCapture(SCIP_INTERRUPT *interrupt)
Definition: interrupt.c:114
type definitions for catching the user CTRL-C interrupt