Class: EventMachine::FileWatch

Inherits:
Connection show all
Defined in:
lib/em/file_watch.rb

Overview

Note:

On Mac OS X, file watching only works when kqueue is enabled

Utility class that is useful for file monitoring. Supported events are

  • File is modified
  • File is deleted
  • File is moved

See Also:

Constant Summary

Instance Attribute Summary

Attributes inherited from Connection

signature

Instance Method Summary (collapse)

Methods inherited from Connection

#close_connection, #close_connection_after_writing, #comm_inactivity_timeout, #comm_inactivity_timeout=, #connection_completed, #detach, #error?, #get_idle_time, #get_peer_cert, #get_peername, #get_pid, #get_proxied_bytes, #get_sock_opt, #get_sockname, #get_status, #notify_readable=, #notify_readable?, #notify_writable=, #notify_writable?, #pause, #paused?, #pending_connect_timeout=, #post_init, #proxy_completed, #proxy_incoming_to, #proxy_target_unbound, #resume, #send_data, #send_datagram, #send_file_data, #set_sock_opt, #ssl_handshake_completed, #ssl_verify_peer, #start_tls, #stop_proxying, #stream_file_data, #unbind

Instance Method Details

- (Object) file_deleted

This method is abstract.
Note:

On Linux (with inotify), this method will not be called until all open file descriptors to the file have been closed.

Will be called when the file is deleted. Supposed to be redefined by subclasses. When the file is deleted, stop_watching will be called after this to make sure everything is cleaned up correctly.



56
57
# File 'lib/em/file_watch.rb', line 56

def file_deleted
end

- (Object) file_modified

This method is abstract.

Will be called when the file is modified. Supposed to be redefined by subclasses.



45
46
# File 'lib/em/file_watch.rb', line 45

def file_modified
end

- (Object) file_moved

This method is abstract.

Will be called when the file is moved or renamed. Supposed to be redefined by subclasses.



62
63
# File 'lib/em/file_watch.rb', line 62

def file_moved
end

- (String) path

Note:

Current implementation does not pick up on the new filename after a rename occurs.

Returns the path that is being monitored.

Returns:

  • (String)

See Also:



38
39
40
# File 'lib/em/file_watch.rb', line 38

def path
  @path
end

- (Object) stop_watching

Discontinue monitoring of the file.

This involves cleaning up the underlying monitoring details with kqueue/inotify, and in turn firing Connection#unbind. This will be called automatically when a file is deleted. User code may call it as well.



69
70
71
# File 'lib/em/file_watch.rb', line 69

def stop_watching
  EventMachine::unwatch_filename(@signature)
end