OmeroBlitz API

omero::grid::monitors::MonitorServer

Overview

interface MonitorServer

Operation Index

createMonitor

Create a monitor of events.

startMonitor

Start an existing monitor.

stopMonitor

Stop an existing monitor.

destroyMonitor

Destroy an existing monitor.

getMonitorState

Get the state of an existing monitor.

Operations

string createMonitor(MonitorType mType, WatchEventList eTypes, PathMode pMode, string pathString, ::Ice::StringSeq whitelist, ::Ice::StringSeq blacklist, float timeout, int blockSize, bool ignoreSysFiles, bool ignoreDirEvents, bool platformCheck, MonitorClient* proxy) throws OmeroFSError

Create a monitor of events. A exception will be raised if the event type or path mode is not supported by the Monitor implementation for a given OS. An exception will be raised if the path does not exist or is inaccessible to the monitor. An exception will be raised if a monitor cannot be created for any other reason.

Parameters

mType

type of monitor to create (MonitorType).

eTypes

a sequence of watch event type to monitor (WatchEventTypeList).

pathString

full path of directory of interest (string).

whitelist

list of files or extensions of interest (Ice::StringSeq).

blacklist

list of directories, files or extensions that are not of interest (Ice::StringSeq).

pMode

path mode of monitor (PathMode).

proxy

a proxy of the client to which notifications will be sent (MonitorClient*).

timeout

time in seconds fo monitor to time out (float).

blockSize

the number of events to pack into each notification (int).

ignoreSysFiles

ignore system files or not (bool).

ignoreDirEvents

ignore directory events (bool).

platformCheck

if true strictly check platform (bool).

Return Value

monitorId, a uuid1 (string).

Exceptions

void startMonitor(string id) throws OmeroFSError

Start an existing monitor. An exception will be raised if the id does not correspond to an existing monitor. An exception will be raised if a monitor cannot be started for any other reason, in this case the monitor's state cannot be assumed.

Parameters

id

monitor id (string).

Exceptions

void stopMonitor(string id) throws OmeroFSError

Stop an existing monitor. Attempting to stop a monitor that is not running raises no exception. An exception will be raised if the id does not correspond to an existing monitor. An exception will be raised if a monitor cannot be stopped for any other reason, in this case the monitor's state cannot be assumed.

Parameters

id

monitor id (string).

Exceptions

void destroyMonitor(string id) throws OmeroFSError

Destroy an existing monitor. Attempting to destroy a monitor that is running will try to first stop the monitor and then destroy it. An exception will be raised if the id does not correspond to an existing monitor. An exception will be raised if a monitor cannot be destroyed (or stopped and destroyed) for any other reason, in this case the monitor's state cannot be assumed.

Parameters

id

monitor id (string).

Exceptions

MonitorState getMonitorState(string id) throws OmeroFSError

Get the state of an existing monitor. An exception will be raised if the id does not correspond to an existing monitor.

Parameters

id

monitor id (string).

Return Value

the monitor state (MonitorState).

Exceptions