ui/software_update.h

   1 /** @file
   2  *
   3  * Wrappers and routines to check for software updates.
   4  *
   5  * Wireshark - Network traffic analyzer
   6  * By Gerald Combs <gerald@wireshark.org>
   7  * Copyright 1998 Gerald Combs
   8  *
   9  * SPDX-License-Identifier: GPL-2.0-or-later
  10  */
  11
  12 #ifndef __SOFTWARE_UPDATE_H__
  13 #define __SOFTWARE_UPDATE_H__
  14
  15 /** @file
  16  *  Automatic update routines.
  17  *
  18  * Routines that integrate with WinSparkle on Windows and Sparkle on
  19  * macOS.
  20  * @ingroup main_ui_group
  21  */
  22
  23 #ifdef __cplusplus
  24 extern "C" {
  25 #endif /* __cplusplus */
  26
  27 /** Initialize software updates.
  28  *
  29  * Does nothing on platforms that don't support software updates.
  30  */
  31 extern void software_update_init(void);
  32
  33 /** Force a software update check.
  34  *
  35  * Does nothing on platforms that don't support software updates.
  36  */
  37 extern void software_update_check(void);
  38
  39 /** Clean up software update checking.
  40  *
  41  * Does nothing on platforms that don't support software updates.
  42  */
  43 extern void software_update_cleanup(void);
  44
  45 /** Fetch a description of the software update mechanism.
  46  *
  47  * @return NULL, "Sparkle", or "WinSparkle".
  48  */
  49 extern const char *software_update_info(void);
  50
  51 #ifdef _WIN32
  52 /** Check to see if Wireshark can shut down safely (e.g. offer to save the
  53  *  current capture). Called from a separate thread.
  54  *
  55  * Does nothing on platforms that don't support software updates.
  56  */
  57 extern int software_update_can_shutdown_callback(void);
  58
  59 /** Shut down Wireshark in preparation for an upgrade. Called from a separate
  60  *  thread.
  61  *
  62  * Does nothing on platforms that don't support software updates.
  63  */
  64 extern void software_update_shutdown_request_callback(void);
  65 #endif
  66
  67 #ifdef __cplusplus
  68 }
  69 #endif /* __cplusplus */
  70
  71 #endif /* __SOFTWARE_UPDATE_H__ */