Pike v8.1 release 6

Method System.FSEvents.EventStream()->create()


Method create

System.FSEvents.EventStream System.FSEvents.EventStream(array(string) paths, float latency, int|void since_when, int|void flags)

Description

Creates a new Public.System.FSEvents.EventStream object

Parameter paths

An array with each element containing a path to a directory, signifying the root of a filesystem hierarchy to be watched for modifications.

Additional paths may be added later using add_path(), though only if the stream is stopped.

Parameter latency

The number of seconds the service should wait after hearing about an event from the kernel before passing it along to the client via its callback. Specifying a larger value may result in more effective temporal coalescing, resulting in fewer callbacks and greater overall efficiency.

Parameter since_when

The service will supply events that have happened after the given event ID. To ask for events "since now" pass the constant kFSEventStreamEventIdSinceNow. Do not pass zero for this value unless you want to receive events for the requested directories "since the beginning of time".

Parameter flags

Flags that modify the behavior of the stream being created. See Apple's FSEvents documentation for details of the various flags available.