org.rococoa.cocoa.carboncore
Interface CarbonCoreLibrary.FSEventStreamCallback

All Superinterfaces:

Callback

Enclosing interface:

CarbonCoreLibrary

public static interface CarbonCoreLibrary.FSEventStreamCallback
extends Callback

FSEventStreamCallback

Discussion:
This is the type of the callback function supplied by the client
when creating a new stream. This callback is invoked by the
service from the client's runloop(s) when events occur, per the
parameters specified when the stream was created.

Parameters:

streamRef:
The stream for which event(s) occurred.

clientCallBackInfo:
The info field that was supplied in the context when this
stream was created.

numEvents:
The number of events being reported in this callback. Each of
the arrays (eventPaths, eventFlags, eventIds) will have this
many elements.

eventPaths:
An array of paths to the directories in which event(s)
occurred. The type of this parameter depends on the flags
passed to FSEventStreamCreate...(). If
kFSEventStreamCreateFlagUseCFTypes was set, then this will be a
CFArrayRef containing CFStringRef objects (per
CFStringCreateWithFileSystemRepresentation()). Ownership
follows the Get rule, and they will be released by the
framework after your callback returns. If
kFSEventStreamCreateFlagUseCFTypes was not set, then the
framework will pass your callback a raw C array of raw C
strings that will be deallocated by the framework after your
callback returns. A path might be "/" if ether of these flags
is set for the event: kFSEventStreamEventFlagUserDropped,
kFSEventStreamEventFlagKernelDropped.

eventFlags:
An array of flag words corresponding to the paths in the
eventPaths parameter. If no flags are set, then there was some
change in the directory at the specific path supplied in this
event. See FSEventStreamEventFlags.

eventIds:
An array of FSEventStreamEventIds corresponding to the paths in
the eventPaths parameter. Each event ID comes from the most
recent event being reported in the corresponding directory
named in the eventPaths parameter. Event IDs all come from a
single global source. They are guaranteed to always be
increasing, usually in leaps and bounds, even across system
reboots and moving drives from one machine to another. Just
before invoking your callback your stream is updated so that
calling the accessor FSEventStreamGetLatestEventId() will
return the largest of the values passed in the eventIds
parameter; if you were to stop processing events from this
stream after this callback and resume processing them later
from a newly-created FSEventStream, this is the value you would
pass for the sinceWhen parameter to the
FSEventStreamCreate...() function.
native declaration : /System/Library/Frameworks/CoreServices.framework/Versions/Current/Frameworks/CarbonCore.framework/Headers/FSEvents.h

Nested Class Summary

Nested classes/interfaces inherited from interface com.sun.jna.Callback

Callback.UncaughtExceptionHandler

Field Summary

Fields inherited from interface com.sun.jna.Callback

FORBIDDEN_NAMES, METHOD_NAME

Method Summary

void	invoke(CarbonCoreLibrary.__FSEventStream streamRef, Pointer clientCallBackInfo, NativeSize numEvents, Pointer eventPaths, IntByReference eventFlags, LongByReference eventIds)

Method Detail

invoke

void invoke(CarbonCoreLibrary.__FSEventStream streamRef,
            Pointer clientCallBackInfo,
            NativeSize numEvents,
            Pointer eventPaths,
            IntByReference eventFlags,
            LongByReference eventIds)