wpi::uv::FsEvent Class Reference

Filesystem Event handle. More...

#include <wpinet/uv/FsEvent.h>

Inheritance diagram for wpi::uv::FsEvent:

Public Member Functions
	FsEvent (const private_init &)
	~FsEvent () noexcept override=default
void	Start (std::string_view path, unsigned int flags=0)
	Start watching the specified path for changes. More...
void	Stop ()
	Stop watching for changes. More...
std::string	GetPath ()
	Get the path being monitored. More...
Public Member Functions inherited from wpi::uv::HandleImpl< FsEvent, uv_fs_event_t >
std::shared_ptr< FsEvent >	shared_from_this ()
std::shared_ptr< const FsEvent >	shared_from_this () const
uv_fs_event_t *	GetRaw () const noexcept
	Get the underlying handle data structure. More...
Public Member Functions inherited from wpi::uv::Handle
	Handle (const Handle &)=delete
	Handle (Handle &&)=delete
Handle &	operator= (const Handle &)=delete
Handle &	operator= (Handle &&)=delete
virtual	~Handle () noexcept
Type	GetType () const noexcept
	Get the type of the handle. More...
std::string_view	GetTypeName () const noexcept
	Get the name of the type of the handle. More...
std::shared_ptr< Loop >	GetLoop () const noexcept
	Get the loop where this handle runs. More...
Loop &	GetLoopRef () const noexcept
	Get the loop where this handle runs. More...
bool	IsActive () const noexcept
	Check if the handle is active. More...
bool	IsClosing () const noexcept
	Check if a handle is closing or closed. More...
void	Close () noexcept
	Request handle to be closed. More...
void	SetLoopClosing (bool loopClosing) noexcept
	Set if the loop is closing. More...
bool	IsLoopClosing () const noexcept
	Get the loop closing status. More...
void	Reference () noexcept
	Reference the given handle. More...
void	Unreference () noexcept
	Unreference the given handle. More...
bool	HasReference () const noexcept
	Check if the given handle is referenced. More...
size_t	RawSize () const noexcept
	Return the size of the underlying handle type. More...
uv_handle_t *	GetRawHandle () const noexcept
	Get the underlying handle data structure. More...
void	SetBufferAllocator (std::function< Buffer(size_t)> alloc, std::function< void(Buffer &)> dealloc)
	Set the functions used for allocating and releasing buffers. More...
void	FreeBuf (Buffer &buf) const noexcept
	Free a buffer. More...
template<typename T = void>
std::shared_ptr< T >	GetData () const
	Gets user-defined data. More...
void	SetData (std::shared_ptr< void > data)
	Sets user-defined data. More...
void	ReportError (int err) const
	Report an error. More...

Static Public Member Functions
static std::shared_ptr< FsEvent >	Create (Loop &loop)
	Create a filesystem event handle. More...
static std::shared_ptr< FsEvent >	Create (const std::shared_ptr< Loop > &loop)
	Create a filesystem event handle. More...

Public Attributes
sig::Signal< const char *, int >	fsEvent
	Signal generated when a filesystem change occurs. More...
Public Attributes inherited from wpi::uv::Handle
sig::Signal< Error >	error
	Error signal. More...
sig::Signal	closed
	Closed signal. More...

Additional Inherited Members
Public Types inherited from wpi::uv::Handle
using	Type = uv_handle_type
Protected Member Functions inherited from wpi::uv::HandleImpl< FsEvent, uv_fs_event_t >
	HandleImpl ()
Protected Member Functions inherited from wpi::uv::Handle
	Handle (uv_handle_t *uv_handle)
void	Keep () noexcept
void	Release () noexcept
void	ForceClosed () noexcept
template<typename F , typename... Args>
bool	Invoke (F &&f, Args &&... args) const
Static Protected Member Functions inherited from wpi::uv::Handle
static void	AllocBuf (uv_handle_t *handle, size_t size, uv_buf_t *buf)
static void	DefaultFreeBuf (Buffer &buf)

Detailed Description

Filesystem Event handle.

Constructor & Destructor Documentation

FsEvent()

wpi::uv::FsEvent::FsEvent ( const private_init &  )

inlineexplicit

~FsEvent()

wpi::uv::FsEvent::~FsEvent ( )

overridedefaultnoexcept

Member Function Documentation

Create() [1/2]

static std::shared_ptr< FsEvent > wpi::uv::FsEvent::Create ( const std::shared_ptr< Loop > &  loop )

inlinestatic

Create a filesystem event handle.

Parameters

loop	Loop object where this handle runs.

Create() [2/2]

static std::shared_ptr< FsEvent > wpi::uv::FsEvent::Create ( Loop &  loop )

static

Create a filesystem event handle.

Parameters

loop	Loop object where this handle runs.

GetPath()

std::string wpi::uv::FsEvent::GetPath

(

)

Get the path being monitored.

Signals error and returns empty string if an error occurs.

Returns

Monitored path.

Start()

void wpi::uv::FsEvent::Start	(	std::string_view	path,
		unsigned int	flags = 0
	)

Start watching the specified path for changes.

Parameters

path	Path to watch for changes
events	Bitmask of event flags. Only UV_FS_EVENT_RECURSIVE is supported (and only on OSX and Windows).

Stop()

void wpi::uv::FsEvent::Stop ( )

inline

Stop watching for changes.

Member Data Documentation

fsEvent

sig::Signal<const char*, int> wpi::uv::FsEvent::fsEvent

Signal generated when a filesystem change occurs.

The first parameter is the filename (if a directory was passed to Start(), the filename is relative to that directory). The second parameter is an ORed mask of UV_RENAME and UV_CHANGE.

---

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

• wpinet/uv/FsEvent.h