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-2021 Konrad-Zuse-Zentrum */
7 /* fuer Informationstechnik Berlin */
8 /* */
9 /* SCIP is distributed under the terms of the ZIB Academic License. */
10 /* */
11 /* You should have received a copy of the ZIB Academic License */
12 /* along with SCIP; see the file COPYING. If not visit scipopt.org. */
13 /* */
14 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 /**@file interrupt.h
17  * @ingroup INTERNALAPI
18  * @brief methods for catching the user CTRL-C interrupt
19  * @author Tobias Achterberg
20  */
21 
22 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
23 
24 #ifndef __SCIP_INTERRUPT_H__
25 #define __SCIP_INTERRUPT_H__
26 
27 
28 #include "scip/def.h"
29 #include "scip/type_retcode.h"
30 #include "scip/type_interrupt.h"
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36 /** creates a CTRL-C interrupt data */
38  SCIP_INTERRUPT** interrupt /**< pointer to store the CTRL-C interrupt data */
39  );
40 
41 /** frees a CTRL-C interrupt data */
43  SCIP_INTERRUPT** interrupt /**< pointer to the CTRL-C interrupt data */
44  );
45 
46 /** captures the CTRL-C interrupt to call the SCIP's own interrupt handler */
48  SCIP_INTERRUPT* interrupt /**< CTRL-C interrupt data */
49  );
50 
51 /** releases the CTRL-C interrupt and restores the old interrupt handler */
53  SCIP_INTERRUPT* interrupt /**< CTRL-C interrupt data */
54  );
55 
56 /** returns whether the user interrupted by pressing CTRL-C */
58  void
59  );
60 
61 /** returns whether the process has received a SIGTERM */
63  void
64  );
65 
66 /** sends a termination signal to all SCIP processes so that they try to terminate as soon as possible
67  *
68  * @note For terminating a specific SCIP process use SCIPinterruptSolve().
69  */
70 void SCIPtryTerminate(
71  void
72  );
73 
74 /** resets the number of interrupts to 0 */
76  void
77  );
78 
79 #ifdef __cplusplus
80 }
81 #endif
82 
83 #endif
void SCIPtryTerminate(void)
Definition: interrupt.c:173
SCIP_RETCODE SCIPinterruptCreate(SCIP_INTERRUPT **interrupt)
Definition: interrupt.c:82
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
type definitions for return codes for SCIP methods
void SCIPresetInterrupted(void)
Definition: interrupt.c:181
SCIP_Bool SCIPterminated(void)
Definition: interrupt.c:162
void SCIPinterruptRelease(SCIP_INTERRUPT *interrupt)
Definition: interrupt.c:135
#define SCIP_Bool
Definition: def.h:70
SCIP_Bool SCIPinterrupted(void)
Definition: interrupt.c:154
void SCIPinterruptFree(SCIP_INTERRUPT **interrupt)
Definition: interrupt.c:95
common defines and data types used in all packages of SCIP
void SCIPinterruptCapture(SCIP_INTERRUPT *interrupt)
Definition: interrupt.c:105
type definitions for catching the user CTRL-C interrupt