uvw::FsPollHandle Class Reference

The FsPollHandle handle. More...

#include <fs_poll.h>

Inheritance diagram for uvw::FsPollHandle:

Collaboration diagram for uvw::FsPollHandle:

Public Member Functions
bool	init ()
	Initializes the handle.
void	start (const std::string &file, Time interval)
	Starts the handle.
void	stop ()
	Stops the handle.
std::string	path () noexcept
	Gets the path being monitored by the handle.
Public Member Functions inherited from uvw::Handle< FsPollHandle, uv_fs_poll_t >
HandleCategory	category () const noexcept
	Gets the category of the handle.
HandleType	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	sendBufferSize ()
	Gets the size of the send buffer used for the socket.
bool	sendBufferSize (int value)
	Sets the size of the send buffer used for the socket.
int	recvBufferSize ()
	Gets the size of the receive buffer used for the socket.
bool	recvBufferSize (int value)
	Sets the size of the receive buffer used for the socket.
OSFileDescriptor	fd () const
	Gets the platform dependent file descriptor equivalent.
Public Member Functions inherited from uvw::Resource< FsPollHandle, uv_fs_poll_t >
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::UnderlyingType< FsPollHandle, uv_fs_poll_t >
Loop &	loop () const noexcept
	Gets the loop from which the resource was originated.
const uv_fs_poll_t *	raw () const noexcept
	Gets the underlying raw data structure.
uv_fs_poll_t *	raw () noexcept
	Gets the underlying raw data structure.
Public Member Functions inherited from uvw::Emitter< FsPollHandle >
Connection< E >	on (Listener< E > f)
	Registers a long-lived listener with the event emitter.
Connection< E >	once (Listener< E > f)
	Registers a short-lived listener with the event emitter.
void	erase (Connection< E > conn) noexcept
	Disconnects a listener from the event emitter.
void	clear () noexcept
	Disconnects all the listeners for the given event type.
void	clear () noexcept
	Disconnects all the listeners.
bool	empty () const noexcept
	Checks if there are listeners registered for the specific event.
bool	empty () const noexcept
	Checks if there are listeners registered with the event emitter.

Additional Inherited Members
Static Public Member Functions inherited from uvw::UnderlyingType< FsPollHandle, uv_fs_poll_t >
static std::shared_ptr< FsPollHandle >	create (Args &&...args)
	Creates a new resource of the given type.

Detailed Description

The FsPollHandle handle.

It allows the user to monitor a given path for changes. Unlike FsEventHandle handles, FsPollHandle handles use stat to detect when a file has changed so they can work on file systems where FsEventHandle handles can’t.

To create a FsPollHandle through a Loop, no arguments are required.

Definition at line 34 of file fs_poll.h.

Member Function Documentation

init()

bool uvw::FsPollHandle::init

(

)

Initializes the handle.

Returns

True in case of success, false otherwise.

path()

std::string uvw::FsPollHandle::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()

void uvw::FsPollHandle::start	(	const std::string &	file,
		Time	interval )

Starts the handle.

The handle will start emitting FsPollEvent when needed.

Parameters

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

---

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

• src/uvw/fs_poll.h