libfswatch.h

Go to the documentation of this file.

/*
 * Copyright (c) 2014-2026 Enrico M. Crisostomo
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation; either version 3, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef LIBFSW_H
#define LIBFSW_H
 
#include <stdbool.h>
#include "libfswatch_types.h"
#include "cevent.h"
#include "cmonitor.h"
#include "cfilter.h"
#include "error.h"
 
#  ifdef __cplusplus
extern "C"
{
#  endif


  FSW_STATUS fsw_init_library(void);

  FSW_HANDLE fsw_init_session(const enum fsw_monitor_type type);

  FSW_STATUS fsw_add_path(const FSW_HANDLE handle, const char * path);

  FSW_STATUS fsw_add_property(const FSW_HANDLE handle, const char * name, const char * value);

  FSW_STATUS fsw_set_allow_overflow(const FSW_HANDLE handle, const bool allow_overflow);

  FSW_STATUS fsw_set_callback(const FSW_HANDLE handle,
                              const FSW_CEVENT_CALLBACK callback,
                              void * data);

  FSW_STATUS fsw_set_callback_v2(const FSW_HANDLE handle,
                                 const FSW_CEVENT_CALLBACK_V2 callback,
                                 void * data);

  FSW_STATUS fsw_set_latency(const FSW_HANDLE handle, const double latency);

  FSW_STATUS fsw_set_recursive(const FSW_HANDLE handle, const bool recursive);

  FSW_STATUS fsw_set_directory_only(const FSW_HANDLE handle, const bool directory_only);

  FSW_STATUS fsw_set_follow_symlinks(const FSW_HANDLE handle,
                                     const bool follow_symlinks);

  FSW_STATUS fsw_add_event_type_filter(const FSW_HANDLE handle,
                                       const fsw_event_type_filter event_type);

  FSW_STATUS fsw_add_filter(const FSW_HANDLE handle,
                            const fsw_cmonitor_filter filter);

  FSW_STATUS fsw_start_monitor(const FSW_HANDLE handle);

  FSW_STATUS fsw_stop_monitor(const FSW_HANDLE handle);

  bool fsw_is_running(const FSW_HANDLE handle);

  FSW_STATUS fsw_destroy_session(const FSW_HANDLE handle);

  FSW_STATUS fsw_last_error(void);

  bool fsw_is_verbose(void);

  void fsw_set_verbose(bool verbose);
 
#  ifdef __cplusplus
}
#  endif
 
#endif /* LIBFSW_H */