uvw::fs_poll_handle Class Reference

The fs poll handle. More...

#include <fs_poll.h>

Inheritance diagram for uvw::fs_poll_handle:

Collaboration diagram for uvw::fs_poll_handle:

Public Member Functions
int	init () final
	Initializes the handle.
int	start (const std::string &file, time interval)
	Starts the handle.
int	stop ()
	Stops the handle.
std::string	path () noexcept
	Gets the path being monitored by the handle.
Public Member Functions inherited from uvw::handle< fs_poll_handle, uv_fs_poll_t, fs_poll_event >
handle_category	category () const noexcept
	Gets the category of the handle.
handle_type	type () const noexcept
	Gets the type of the handle.
bool	active () const noexcept
	Checks if the handle is active.
bool	closing () const noexcept
	Checks if a handle is closing or closed.
void	close () noexcept
	Request handle to be closed.
void	reference () noexcept
	Reference the given handle.
void	unreference () noexcept
	Unreference the given handle.
bool	referenced () const noexcept
	Checks if the given handle referenced.
std::size_t	size () const noexcept
	Returns the size of the underlying handle type.
int	send_buffer_size ()
	Gets the size of the send buffer used for the socket.
int	send_buffer_size (int value)
	Sets the size of the send buffer used for the socket.
int	recv_buffer_size ()
	Gets the size of the receive buffer used for the socket.
int	recv_buffer_size (int value)
	Sets the size of the receive buffer used for the socket.
os_file_descriptor	fd () const
	Gets the platform dependent file descriptor equivalent.
Public Member Functions inherited from uvw::resource< T, U, E >
template<typename R = void>
std::shared_ptr< R >	data () const
	Gets user-defined data. uvw won't use this field in any case.
void	data (std::shared_ptr< void > udata)
	Sets arbitrary data. uvw won't use this field in any case.
Public Member Functions inherited from uvw::uv_type< U >
virtual int	init ()
	Initializes the handle.
loop &	parent () const noexcept
	Gets the loop from which the resource was originated.
const U *	raw () const noexcept
	Gets the underlying raw data structure.
U *	raw () noexcept
	Gets the underlying raw data structure.
Public Member Functions inherited from uvw::emitter< T, E... >
void	on (listener_t< U > f)
	Registers a long-lived listener with the event emitter.
void	reset () noexcept
	Disconnects the listener for the given event type.
void	reset () noexcept
	Disconnects all listeners.
bool	has () const noexcept
	Checks if there is a listener registered for the specific event.

Detailed Description

The fs poll handle.

It allows users to monitor a given path for changes. Unlike fs_event_handle, fs_poll_handle uses stat to detect when a file has changed so it can work on file systems where fs_event_handle handles can’t.

To create a fs_poll_handle through a loop, no arguments are required.

Definition at line 31 of file fs_poll.h.

Member Function Documentation

init()

int uvw::fs_poll_handle::init ( )

finalvirtual

Initializes the handle.

Returns

Underlying return value.

Reimplemented from uvw::uv_type< U >.

path()

std::string uvw::fs_poll_handle::path ( )

noexcept

Gets the path being monitored by the handle.

Returns

The path being monitored by the handle, an empty string in case of errors.

start()

int uvw::fs_poll_handle::start	(	const std::string &	file,
		time	interval
	)

Starts the handle.

The handle will start emitting fs_poll_event when needed.

Parameters

file	The path to the file to be checked.
interval	Milliseconds between successive checks.

Returns

Underlying return value.

stop()

int uvw::fs_poll_handle::stop

(

)

Stops the handle.

Returns

Underlying return value.

---

The documentation for this class was generated from the following file:

• src/uvw/fs_poll.h