# Class System.FSEvents.EventStream

Inheritance graph

Constant kFSEventStreamCreateFlagFileEvents

  ``constant` System.FSEvents.EventStream.`kFSEventStreamCreateFlagFileEvents``

Description

  Available in MacOS X 10.7 and newer.

Constant kFSEventStreamCreateFlagIgnoreSelf

  ``constant` System.FSEvents.EventStream.`kFSEventStreamCreateFlagIgnoreSelf``

Description

  Available in MacOS X 10.6 and newer.

Constant kFSEventStreamCreateFlagNoDefer

  ``constant` System.FSEvents.EventStream.`kFSEventStreamCreateFlagNoDefer``

Constant kFSEventStreamCreateFlagNone

  ``constant` System.FSEvents.EventStream.`kFSEventStreamCreateFlagNone``

Constant kFSEventStreamCreateFlagWatchRoot

  ``constant` System.FSEvents.EventStream.`kFSEventStreamCreateFlagWatchRoot``

Constant kFSEventStreamEventFlagChangeOwner

  ``constant` System.FSEvents.EventStream.`kFSEventStreamEventFlagChangeOwner``

Description

  Available in MacOS X 10.7 and newer.

Constant kFSEventStreamEventFlagEventIdsWrapped

  ``constant` System.FSEvents.EventStream.`kFSEventStreamEventFlagEventIdsWrapped``

Constant kFSEventStreamEventFlagFinderInfoMod

  ``constant` System.FSEvents.EventStream.`kFSEventStreamEventFlagFinderInfoMod``

Description

  Available in MacOS X 10.7 and newer.

Constant kFSEventStreamEventFlagHistoryDone

  ``constant` System.FSEvents.EventStream.`kFSEventStreamEventFlagHistoryDone``

Constant kFSEventStreamEventFlagInodeMetaMod

  ``constant` System.FSEvents.EventStream.`kFSEventStreamEventFlagInodeMetaMod``

Description

  Available in MacOS X 10.7 and newer.

Constant kFSEventStreamEventFlagIsDir

  ``constant` System.FSEvents.EventStream.`kFSEventStreamEventFlagIsDir``

Description

  Available in MacOS X 10.7 and newer.

Constant kFSEventStreamEventFlagIsFile

  ``constant` System.FSEvents.EventStream.`kFSEventStreamEventFlagIsFile``

Description

  Available in MacOS X 10.7 and newer.

Constant kFSEventStreamEventFlagIsSymlink

  ``constant` System.FSEvents.EventStream.`kFSEventStreamEventFlagIsSymlink``

Description

  Available in MacOS X 10.7 and newer.

Constant kFSEventStreamEventFlagItemCreated

  ``constant` System.FSEvents.EventStream.`kFSEventStreamEventFlagItemCreated``

Description

  Available in MacOS X 10.7 and newer.

Constant kFSEventStreamEventFlagItemModified

  ``constant` System.FSEvents.EventStream.`kFSEventStreamEventFlagItemModified``

Description

  Available in MacOS X 10.7 and newer.

Constant kFSEventStreamEventFlagItemRemoved

  ``constant` System.FSEvents.EventStream.`kFSEventStreamEventFlagItemRemoved``

Description

  Available in MacOS X 10.7 and newer.

Constant kFSEventStreamEventFlagKernelDropped

  ``constant` System.FSEvents.EventStream.`kFSEventStreamEventFlagKernelDropped``

Constant kFSEventStreamEventFlagMount

  ``constant` System.FSEvents.EventStream.`kFSEventStreamEventFlagMount``

Constant kFSEventStreamEventFlagMustScanSubDirs

  ``constant` System.FSEvents.EventStream.`kFSEventStreamEventFlagMustScanSubDirs``

Constant kFSEventStreamEventFlagNone

  ``constant` System.FSEvents.EventStream.`kFSEventStreamEventFlagNone``

Constant kFSEventStreamEventFlagRenamed

  ``constant` System.FSEvents.EventStream.`kFSEventStreamEventFlagRenamed``

Description

  Available in MacOS X 10.7 and newer.

Constant kFSEventStreamEventFlagRootChanged

  ``constant` System.FSEvents.EventStream.`kFSEventStreamEventFlagRootChanged``

Constant kFSEventStreamEventFlagUnmount

  ``constant` System.FSEvents.EventStream.`kFSEventStreamEventFlagUnmount``

Constant kFSEventStreamEventFlagUserDropped

  ``constant` System.FSEvents.EventStream.`kFSEventStreamEventFlagUserDropped``

Constant kFSEventStreamEventFlagXattrMod

  ``constant` System.FSEvents.EventStream.`kFSEventStreamEventFlagXattrMod``

Description

  Available in MacOS X 10.7 and newer.

Constant kFSEventStreamEventIdSinceNow

  ``constant` System.FSEvents.EventStream.`kFSEventStreamEventIdSinceNow``

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.