This repository has been archived by the owner on Sep 10, 2021. It is now read-only.
forked from eventmachine/eventmachine
/
file_watch.rb
54 lines (46 loc) · 1.76 KB
/
file_watch.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
module EventMachine
# This is subclassed from EventMachine::Connection for use with the file monitoring API. Read the
# documentation on the instance methods of this class, and for a full explanation see EventMachine.watch.
class FileWatch < Connection
# :stopdoc:
Cmodified = 'modified'.freeze
Cdeleted = 'deleted'.freeze
Cmoved = 'moved'.freeze
# :startdoc:
def receive_data(data) #:nodoc:
case data
when Cmodified
file_modified
when Cdeleted
file_deleted
when Cmoved
file_moved
end
end
# Returns the path that EventMachine::watch was originally called with. The current implementation
# does not pick up on the new filename after a rename occurs.
def path
@path
end
# Should be redefined with the user's custom callback that will be fired when the file is modified.
def file_modified
end
# Should be redefined with the user's custom callback that will be fired when the file is deleted.
# When the file is deleted, stop_watching will be called after this to make sure everything is
# cleaned up correctly.
#
# Note that on linux (with inotify), file_deleted will not be called until all open file descriptors to
# the file have been closed.
def file_deleted
end
# Should be redefined with the user's custom callback that will be fired when the file is moved or renamed.
def file_moved
end
# Discontinue monitoring of the file.
# This involves cleaning up the underlying monitoring details with kqueue/inotify, and in turn firing unbind.
# This will be called automatically when a file is deleted. User code may call it as well.
def stop_watching
EventMachine::unwatch_filename(@signature)
end
end
end