WPILibC++  2019.3.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
wpi::uv::FsEvent Class Referencefinal

Filesystem Event handle. More...

#include <FsEvent.h>

Inheritance diagram for wpi::uv::FsEvent:
wpi::uv::HandleImpl< FsEvent, uv_fs_event_t > wpi::uv::Handle

Public Member Functions

 FsEvent (const private_init &)
 
void Start (const Twine &path, unsigned int flags=0)
 Start watching the specified path for changes. More...
 
void Stop ()
 Stop watching for changes.
 
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< FsEventshared_from_this ()
 
std::shared_ptr< const FsEventshared_from_this () const
 
uv_fs_event_tGetRaw () const noexcept
 Get the underlying handle data structure. More...
 
- Public Member Functions inherited from wpi::uv::Handle
 Handle (const Handle &)=delete
 
 Handle (Handle &&)=delete
 
Handleoperator= (const Handle &)=delete
 
Handleoperator= (Handle &&)=delete
 
Type GetType () const noexcept
 Get the type of the handle. More...
 
StringRef GetTypeName () const noexcept
 Get the name of the type of the handle. More...
 
std::shared_ptr< LoopGetLoop () const noexcept
 Get the loop where this handle runs. More...
 
LoopGetLoopRef () 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 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_tGetRawHandle () 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)
 Report an error. More...
 

Static Public Member Functions

static std::shared_ptr< FsEventCreate (Loop &loop)
 Create a filesystem event handle. More...
 
static std::shared_ptr< FsEventCreate (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< Errorerror
 Error signal.
 
sig::Signal closed
 Closed signal.
 

Additional Inherited Members

- Public Types inherited from wpi::uv::Handle
using Type = uv_handle_type
 
- 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)
 
- 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.

Member Function Documentation

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

Create a filesystem event handle.

Parameters
loopLoop object where this handle runs.
static std::shared_ptr<FsEvent> wpi::uv::FsEvent::Create ( const std::shared_ptr< Loop > &  loop)
inlinestatic

Create a filesystem event handle.

Parameters
loopLoop object where this handle runs.
std::string wpi::uv::FsEvent::GetPath ( )

Get the path being monitored.

Signals error and returns empty string if an error occurs.

Returns
Monitored path.
void wpi::uv::FsEvent::Start ( const Twine path,
unsigned int  flags = 0 
)

Start watching the specified path for changes.

Parameters
pathPath to watch for changes
eventsBitmask of event flags. Only UV_FS_EVENT_RECURSIVE is supported (and only on OSX and Windows).

Member Data Documentation

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: