Interface FileSystemWatcherService

Singleton implementation of the watch server.

Since multiple clients all make requests to this service, we need to track those individually via a clientId.

Hierarchy

JsonRpcServer<FileSystemWatcherServiceClient>
- FileSystemWatcherService

Index

Methods

Methods

dispose

dispose(): void

Inherited from JsonRpcServer.dispose
- Defined in packages/core/lib/common/disposable.d.ts:21
Dispose this object.

Returns void

Optional getClient

getClient(): undefined | FileSystemWatcherServiceClient

Inherited from JsonRpcServer.getClient
- Defined in packages/core/lib/common/messaging/proxy-factory.d.ts:27
Returns undefined | FileSystemWatcherServiceClient

setClient

setClient(client: undefined | FileSystemWatcherServiceClient): void

Inherited from JsonRpcServer.setClient
- Defined in packages/core/lib/common/messaging/proxy-factory.d.ts:26
If this server is a proxy to a remote server then a client is used as a local object to handle JSON-RPC messages from the remote server.

Parameters
- client: undefined | FileSystemWatcherServiceClient
Returns void

unwatchFileChanges

unwatchFileChanges(watcherId: number): Promise<void>

- Defined in packages/filesystem/src/common/filesystem-watcher-protocol.ts:39
Parameters
- watcherId: number
  
  handle mapping to a previous watchFileChanges request.
Returns Promise<void>

watchFileChanges

watchFileChanges(clientId: number, uri: string, options?: WatchOptions): Promise<number>

- Defined in packages/filesystem/src/common/filesystem-watcher-protocol.ts:35
Parameters
- clientId: number
  
  arbitrary id used to identify a client.
- uri: string
  
  the path to watch.
- Optional options: WatchOptions
  
  optional parameters.
Returns Promise<number>

promise to a unique number handle for this request.