SubmittingPatches: reword awkward phrasing
[alt-git.git] / fsmonitor-ipc.h
blob8b489da762b04756b2373332eb72634889d96b7f
1 #ifndef FSMONITOR_IPC_H
2 #define FSMONITOR_IPC_H
4 #include "simple-ipc.h"
6 struct repository;
8 /*
9 * Returns true if built-in file system monitor daemon is defined
10 * for this platform.
12 int fsmonitor_ipc__is_supported(void);
15 * Returns the pathname to the IPC named pipe or Unix domain socket
16 * where a `git-fsmonitor--daemon` process will listen. This is a
17 * per-worktree value.
19 * Returns NULL if the daemon is not supported on this platform.
21 const char *fsmonitor_ipc__get_path(struct repository *r);
24 * Try to determine whether there is a `git-fsmonitor--daemon` process
25 * listening on the IPC pipe/socket.
27 enum ipc_active_state fsmonitor_ipc__get_state(void);
30 * Connect to a `git-fsmonitor--daemon` process via simple-ipc
31 * and ask for the set of changed files since the given token.
33 * Spawn a daemon process in the background if necessary.
35 * Returns -1 on error; 0 on success.
37 int fsmonitor_ipc__send_query(const char *since_token,
38 struct strbuf *answer);
41 * Connect to a `git-fsmonitor--daemon` process via simple-ipc and
42 * send a command verb. If no daemon is available, we DO NOT try to
43 * start one.
45 * Returns -1 on error; 0 on success.
47 int fsmonitor_ipc__send_command(const char *command,
48 struct strbuf *answer);
50 #endif /* FSMONITOR_IPC_H */