Class INodeManager

Hierarchy

CreateDestroyStartStop
- INodeManager

Index

Constructors

Properties

[initLock] dataDbPath db dirsDbPath gcDbPath iNodeAllocations iNodeCounter iNodesDbPath linkDbPath logger mgrDbPath refs statsDbPath

Accessors

[destroyed] [eventHandled] [eventHandlers] [eventTarget] [handleEventError] [running] [statusP] [status]

Constructors

constructor

new INodeManager(__namedParameters): INodeManager
Parameters
- __namedParameters: {
  db: DB;
  logger: Logger;
  }
  - db: DB
  - logger: Logger
Returns INodeManager
Inherited from createDestroyStartStop.CreateDestroyStartStop.constructor
- Defined in src/inodes/INodeManager.ts:69

Properties

`Readonly` [initLock]

[initLock]: RWLockWriter

`Readonly` dataDbPath

dataDbPath: readonly (string | Buffer)[] = ...

`Protected` db

db: DB

`Readonly` dirsDbPath

dirsDbPath: readonly (string | Buffer)[] = ...

`Readonly` gcDbPath

gcDbPath: readonly (string | Buffer)[] = ...

`Protected` iNodeAllocations

iNodeAllocations: Map<string, Ref<INodeIndex>> = ...

`Protected` iNodeCounter

iNodeCounter: Counter = ...

`Readonly` iNodesDbPath

iNodesDbPath: readonly (string | Buffer)[] = ...

`Readonly` linkDbPath

linkDbPath: readonly (string | Buffer)[] = ...

`Protected` logger

logger: Logger

`Readonly` mgrDbPath

mgrDbPath: readonly (string | Buffer)[] = ...

`Protected` refs

refs: Map<INodeIndex, number> = ...

`Readonly` statsDbPath

statsDbPath: readonly (string | Buffer)[] = ...

Accessors

[destroyed]

get [destroyed](): boolean
Returns boolean
Inherited from createDestroyStartStop.CreateDestroyStartStop.[destroyed]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:7

[eventHandled]

get [eventHandled](): ReadonlyWeakSet<Event>
Returns ReadonlyWeakSet<Event>
Inherited from createDestroyStartStop.CreateDestroyStartStop.[eventHandled]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:7

[eventHandlers]

get [eventHandlers](): ReadonlyMap<string, Set<EventHandlerInfo>>
Returns ReadonlyMap<string, Set<EventHandlerInfo>>
Inherited from createDestroyStartStop.CreateDestroyStartStop.[eventHandlers]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:6

[eventTarget]

get [eventTarget](): EventTarget
Returns EventTarget
Inherited from createDestroyStartStop.CreateDestroyStartStop.[eventTarget]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:5

[handleEventError]

get [handleEventError](): ((evt) => void)
Returns ((evt) => void)
- - (evt): void
  - Parameters
    - evt: EventError
    Returns void
Inherited from createDestroyStartStop.CreateDestroyStartStop.[handleEventError]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:8

[running]

get [running](): boolean
Returns boolean
Inherited from createDestroyStartStop.CreateDestroyStartStop.[running]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:6

[statusP]

get [statusP](): Promise<Status>
Returns Promise<Status>
Inherited from createDestroyStartStop.CreateDestroyStartStop.[statusP]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:9

[status]

get [status](): Status
Returns Status
Inherited from createDestroyStartStop.CreateDestroyStartStop.[status]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:8

Methods

`Protected` _dirDestroy

_dirDestroy(ino, tran): Promise<void>
Parameters
- ino: INodeIndex
- tran: DBTransaction
Returns Promise<void>
- Defined in src/inodes/INodeManager.ts:513

`Protected` _fileDestroy

_fileDestroy(ino, tran): Promise<void>
Parameters
- ino: INodeIndex
- tran: DBTransaction
Returns Promise<void>
- Defined in src/inodes/INodeManager.ts:489

`Protected` _statGetProp

_statGetProp<Key>(ino, key, tran): Promise<StatProps[Key]>
Type Parameters
- Key extends NonFunctionPropertyNames<Stat>
Parameters
- ino: INodeIndex
- key: Key
- tran: DBTransaction
Returns Promise<StatProps[Key]>
- Defined in src/inodes/INodeManager.ts:785

`Protected` _statSetProp

_statSetProp<Key>(ino, key, value, tran): Promise<void>
Type Parameters
- Key extends NonFunctionPropertyNames<Stat>
Parameters
- ino: INodeIndex
- key: Key
- value: StatProps[Key]
- tran: DBTransaction
Returns Promise<void>
- Defined in src/inodes/INodeManager.ts:830

`Protected` _symlinkDestroy

_symlinkDestroy(ino, tran): Promise<void>
Parameters
- ino: INodeIndex
- tran: DBTransaction
Returns Promise<void>
- Defined in src/inodes/INodeManager.ts:543

`Protected` _unlink

_unlink(ino, tran): Promise<void>
Parameters
- ino: INodeIndex
- tran: DBTransaction
Returns Promise<void>
- Defined in src/inodes/INodeManager.ts:655

addEventListener

addEventListener(type, callback, options?): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void
Inherited from createDestroyStartStop.CreateDestroyStartStop.addEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:9

destroy

destroy(): Promise<void>
Returns Promise<void>
Inherited from createDestroyStartStop.CreateDestroyStartStop.destroy
- Defined in src/inodes/INodeManager.ts:107

dirCreate

dirCreate(ino, params, parent?, tran?): Promise<void>
Parameters
- ino: INodeIndex
- params: Partial<Omit<INodeParams, "ino">>
- Optional parent: INodeIndex
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/inodes/INodeManager.ts:352

dirDestroy

dirDestroy(ino, tran?): Promise<void>
Parameters
- ino: INodeIndex
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/inodes/INodeManager.ts:500

dirGet

dirGet(ino, tran?): AsyncGenerator<[string, INodeIndex], any, unknown>
Parameters
- ino: INodeIndex
- Optional tran: DBTransaction
Returns AsyncGenerator<[string, INodeIndex], any, unknown>
- Defined in src/inodes/INodeManager.ts:895

dirGetEntry

dirGetEntry(ino, name, tran?): Promise<undefined | INodeIndex>
Parameters
- ino: INodeIndex
- name: string
- Optional tran: DBTransaction
Returns Promise<undefined | INodeIndex>
- Defined in src/inodes/INodeManager.ts:913

dirGetRoot

dirGetRoot(tran?): Promise<undefined | INodeIndex>
Parameters
- Optional tran: DBTransaction
Returns Promise<undefined | INodeIndex>
- Defined in src/inodes/INodeManager.ts:874

dirResetEntry

dirResetEntry(ino, nameOld, nameNew, tran?): Promise<void>
Parameters
- ino: INodeIndex
- nameOld: string
- nameNew: string
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/inodes/INodeManager.ts:983

dirSetEntry

dirSetEntry(ino, name, value, tran?): Promise<void>
Parameters
- ino: INodeIndex
- name: string
- value: INodeIndex
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/inodes/INodeManager.ts:928

`Protected` dirSetRoot

dirSetRoot(ino, tran): Promise<void>
Parameters
- ino: INodeIndex
- tran: DBTransaction
Returns Promise<void>
- Defined in src/inodes/INodeManager.ts:884

dirUnsetEntry

dirUnsetEntry(ino, name, tran?): Promise<void>
Parameters
- ino: INodeIndex
- name: string
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/inodes/INodeManager.ts:960

`Protected` dirUnsetRoot

dirUnsetRoot(tran): Promise<void>
Parameters
- tran: DBTransaction
Returns Promise<void>
- Defined in src/inodes/INodeManager.ts:891

dispatchEvent

dispatchEvent(event): boolean
Parameters
- event: Event
Returns boolean
Inherited from createDestroyStartStop.CreateDestroyStartStop.dispatchEvent
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:11

fileClearData

fileClearData(ino, tran?): Promise<void>
Modified and Change Time are both updated here as this is exposed to the EFS functions to be used
Parameters
- ino: INodeIndex
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/inodes/INodeManager.ts:1037

fileCreate

fileCreate(ino, params, blkSize, data?, tran?): Promise<void>
Parameters
- ino: INodeIndex
- params: Partial<Omit<INodeParams, "ino">>
- blkSize: number
- Optional data: Buffer
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/inodes/INodeManager.ts:320

fileDestroy

fileDestroy(ino, tran?): Promise<void>
Parameters
- ino: INodeIndex
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/inodes/INodeManager.ts:476

`Protected` fileGetBlock

fileGetBlock(ino, idx, tran): Promise<undefined | Buffer>
Access time not updated here, handled at higher level as this is only accessed by fds and and other INodeMgr functions
Parameters
- ino: INodeIndex
- idx: number
- tran: DBTransaction
Returns Promise<undefined | Buffer>
- Defined in src/inodes/INodeManager.ts:1123

fileGetBlocks

fileGetBlocks(ino, blockSize, startIdx?, endIdx?, tran?): AsyncGenerator<Buffer, any, unknown>
Access time not updated here, handled at higher level as this is only accessed by fds and and other INodeMgr functions
Parameters
- ino: INodeIndex
- blockSize: number
- startIdx: number = 0
- Optional endIdx: number
- Optional tran: DBTransaction
Returns AsyncGenerator<Buffer, any, unknown>
- Defined in src/inodes/INodeManager.ts:1055

fileGetLastBlock

fileGetLastBlock(ino, tran?): Promise<[number, Buffer]>
Access time not updated here, handled at higher level as this is only accessed by fds and and other INodeMgr functions
Parameters
- ino: INodeIndex
- Optional tran: DBTransaction
Returns Promise<[number, Buffer]>
- Defined in src/inodes/INodeManager.ts:1094

fileSetBlocks

fileSetBlocks(ino, data, blockSize, startIdx?, tran?): Promise<void>
Modified and Change time not updated here, handled at higher level as this is only accessed by fds and and other INodeMgr functions
Parameters
- ino: INodeIndex
- data: Buffer
- blockSize: number
- startIdx: number = 0
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/inodes/INodeManager.ts:1141

fileWriteBlock

fileWriteBlock(ino, data, idx, offset?, tran?): Promise<number>
Modified and Change time not updated here, handled at higher level as this is only accessed by fds and other INodeMgr functions
Parameters
- ino: INodeIndex
- data: Buffer
- idx: number
- offset: number = 0
- Optional tran: DBTransaction
Returns Promise<number>
- Defined in src/inodes/INodeManager.ts:1166

`Protected` gc

gc(ino, tran): Promise<void>
Parameters
- ino: INodeIndex
- tran: DBTransaction
Returns Promise<void>
- Defined in src/inodes/INodeManager.ts:680

`Protected` gcAll

gcAll(): Promise<void>
Delete iNodes that were scheduled for deletion These iNodes could not be deleted because of an existing reference This is used during this.start and this.stop, and thus does not use any locks This must only be called when there are no active this.refs or this.locks

Returns Promise<void>
- Defined in src/inodes/INodeManager.ts:119

get

get(ino, tran?): Promise<undefined | INodeData>
Gets the INodeData Use this to test if an ino number exists You can use the returned ino for subsequent operations
Parameters
- ino: INodeIndex
- Optional tran: DBTransaction
Returns Promise<undefined | INodeData>
- Defined in src/inodes/INodeManager.ts:584

getAll

getAll(tran?): AsyncGenerator<INodeData, any, unknown>
Parameters
- Optional tran: DBTransaction
Returns AsyncGenerator<INodeData, any, unknown>
- Defined in src/inodes/INodeManager.ts:610

`Protected` iNodeCreate

iNodeCreate(type, params, tran): Promise<void>
Parameters
- type: INodeType
- params: INodeParams
- tran: DBTransaction
Returns Promise<void>
- Defined in src/inodes/INodeManager.ts:429

`Protected` iNodeDestroy

iNodeDestroy(ino, tran): Promise<void>
Parameters
- ino: INodeIndex
- tran: DBTransaction
Returns Promise<void>
- Defined in src/inodes/INodeManager.ts:551

inoAllocate

inoAllocate(): INodeIndex
Returns INodeIndex
- Defined in src/inodes/INodeManager.ts:150

inoAllocation

inoAllocation(navigated?): ResourceAcquire<INodeIndex>
INodeIndex allocation resource This resource represents potentially INodeIndex being allocated The navigated parameter tells us where the first hardlink for this INodeIndex will be set If left to be undefined, it is assumed that you are allocating the root INodeIndex Concurrent call with same navigated parameter will result in the same INodeIndex result This is essential to enable mutual-exclusion
Parameters
- Optional navigated: Readonly<{
  dir: INodeIndex;
  name: string;
  }>
Returns ResourceAcquire<INodeIndex>
- Defined in src/inodes/INodeManager.ts:166

inoDeallocate

inoDeallocate(ino): void
Parameters
- ino: INodeIndex
Returns void
- Defined in src/inodes/INodeManager.ts:154

link

link(ino, tran?): Promise<void>
Parameters
- ino: INodeIndex
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/inodes/INodeManager.ts:638

ref

ref(ino): void
Parameters
- ino: INodeIndex
Returns void
- Defined in src/inodes/INodeManager.ts:661

removeEventListener

removeEventListener(type, callback, options?): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void
Inherited from createDestroyStartStop.CreateDestroyStartStop.removeEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:10

start

start(__namedParameters): Promise<void>
Parameters
- __namedParameters: {
  fresh?: boolean;
  }
  - Optional fresh?: boolean
Returns Promise<void>
Inherited from createDestroyStartStop.CreateDestroyStartStop.start
- Defined in src/inodes/INodeManager.ts:74

statGet

statGet(ino, tran?): Promise<Stat>
Parameters
- ino: INodeIndex
- Optional tran: DBTransaction
Returns Promise<Stat>
- Defined in src/inodes/INodeManager.ts:715

statGetProp

statGetProp<Key>(ino, key, tran?): Promise<StatProps[Key]>
Type Parameters
- Key extends NonFunctionPropertyNames<Stat>
Parameters
- ino: INodeIndex
- key: Key
- Optional tran: DBTransaction
Returns Promise<StatProps[Key]>
- Defined in src/inodes/INodeManager.ts:771

statSetProp

statSetProp<Key>(ino, key, value, tran?): Promise<void>
Type Parameters
- Key extends NonFunctionPropertyNames<Stat>
Parameters
- ino: INodeIndex
- key: Key
- value: StatProps[Key]
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/inodes/INodeManager.ts:815

statUnsetProp

statUnsetProp<Key>(ino, key, tran?): Promise<void>
Type Parameters
- Key extends NonFunctionPropertyNames<Stat>
Parameters
- ino: INodeIndex
- key: Key
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/inodes/INodeManager.ts:859

stop

stop(): Promise<void>
It is expected that all references and locks are no longer active This means users of INodeManager must be stopped before calling this

Returns Promise<void>
Inherited from createDestroyStartStop.CreateDestroyStartStop.stop
- Defined in src/inodes/INodeManager.ts:95

symlinkCreate

symlinkCreate(ino, params, link, tran?): Promise<void>
Parameters
- ino: INodeIndex
- params: Partial<Omit<INodeParams, "ino">>
- link: string
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/inodes/INodeManager.ts:404

symlinkDestroy

symlinkDestroy(ino, tran?): Promise<void>
Parameters
- ino: INodeIndex
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/inodes/INodeManager.ts:530

symlinkGetLink

symlinkGetLink(ino, tran?): Promise<string>
Parameters
- ino: INodeIndex
- Optional tran: DBTransaction
Returns Promise<string>
- Defined in src/inodes/INodeManager.ts:1016

transaction

transaction(...inos): ResourceAcquire<DBTransaction>
Parameters
- Rest ...inos: INodeIndex[]
Returns ResourceAcquire<DBTransaction>
- Defined in src/inodes/INodeManager.ts:203

unlink

unlink(ino, tran?): Promise<void>
Parameters
- ino: INodeIndex
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/inodes/INodeManager.ts:647

unref

unref(ino, tran?): any
Parameters
- ino: INodeIndex
- Optional tran: DBTransaction
Returns any
- Defined in src/inodes/INodeManager.ts:667

withNewINodeTransactionF

withNewINodeTransactionF<T>(...params): Promise<T>
Type Parameters
- T
Parameters
- Rest ...params: [...inos: INodeIndex[], f: ((ino, tran) => Promise<T>)] | [navigated: Readonly<{
  dir: INodeIndex;
  name: string;
  }>, ...inos: INodeIndex[], f: ((ino, tran) => Promise<T>)]
Returns Promise<T>
- Defined in src/inodes/INodeManager.ts:248

withNewINodeTransactionG

withNewINodeTransactionG<T, TReturn, TNext>(...params): AsyncGenerator<T, TReturn, TNext>
Type Parameters
- T
- TReturn
- TNext
Parameters
- Rest ...params: [...inos: INodeIndex[], g: ((ino, tran) => AsyncGenerator<T, TReturn, TNext>)] | [navigated: Readonly<{
  dir: INodeIndex;
  name: string;
  }>, ...inos: INodeIndex[], g: ((ino, tran) => AsyncGenerator<T, TReturn, TNext>)]
Returns AsyncGenerator<T, TReturn, TNext>
- Defined in src/inodes/INodeManager.ts:281

withTransactionF

withTransactionF<T>(...params): Promise<T>
Type Parameters
- T
Parameters
- Rest ...params: [...inos: INodeIndex[], f: ((tran) => Promise<T>)]
Returns Promise<T>
- Defined in src/inodes/INodeManager.ts:214

withTransactionG

withTransactionG<T, TReturn, TNext>(...params): AsyncGenerator<T, TReturn, TNext>
Type Parameters
- T
- TReturn
- TNext
Parameters
- Rest ...params: [...inos: INodeIndex[], g: ((tran) => AsyncGenerator<T, TReturn, TNext>)]
Returns AsyncGenerator<T, TReturn, TNext>
- Defined in src/inodes/INodeManager.ts:230

`Static` createINodeManager

createINodeManager(__namedParameters): Promise<INodeManager>
Parameters
- __namedParameters: {
      counter?: any;
      db: DB;
      fresh?: boolean;
      logger?: Logger;
  }
  - Optional counter?: any
  - db: DB
  - Optional fresh?: boolean
  - Optional logger?: Logger
Returns Promise<INodeManager>
- Defined in src/inodes/INodeManager.ts:34

Class INodeManager

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: { db: DB; logger: Logger; }

db: DB

logger: Logger

Returns INodeManager

Properties

Readonly [initLock]

Readonly dataDbPath

Protected db

Readonly dirsDbPath

Readonly gcDbPath

Protected iNodeAllocations

Protected iNodeCounter

Readonly iNodesDbPath

Readonly linkDbPath

Protected logger

Readonly mgrDbPath

Protected refs

Readonly statsDbPath

Accessors

[destroyed]

Returns boolean

[eventHandled]

Returns ReadonlyWeakSet<Event>

[eventHandlers]

Returns ReadonlyMap<string, Set<EventHandlerInfo>>

[eventTarget]

Returns EventTarget

[handleEventError]

Returns ((evt) => void)

Parameters

evt: EventError

Returns void

[running]

Returns boolean

[statusP]

Returns Promise<Status>

[status]

Returns Status

Methods

Protected _dirDestroy

Parameters

ino: INodeIndex

tran: DBTransaction

Returns Promise<void>

Protected _fileDestroy

Parameters

ino: INodeIndex

tran: DBTransaction

Returns Promise<void>

Protected _statGetProp

Type Parameters

Key extends NonFunctionPropertyNames<Stat>

Parameters

ino: INodeIndex

key: Key

tran: DBTransaction

Returns Promise<StatProps[Key]>

Protected _statSetProp

Type Parameters

Key extends NonFunctionPropertyNames<Stat>

Parameters

ino: INodeIndex

key: Key

value: StatProps[Key]

tran: DBTransaction

Returns Promise<void>

Protected _symlinkDestroy

Parameters

ino: INodeIndex

tran: DBTransaction

__namedParameters: {
db: DB;
logger: Logger;
}

`Readonly` [initLock]

`Readonly` dataDbPath

`Protected` db

`Readonly` dirsDbPath

`Readonly` gcDbPath

`Protected` iNodeAllocations

`Protected` iNodeCounter

`Readonly` iNodesDbPath

`Readonly` linkDbPath

`Protected` logger

`Readonly` mgrDbPath

`Protected` refs

`Readonly` statsDbPath

`Protected` _dirDestroy

`Protected` _fileDestroy

`Protected` _statGetProp

`Protected` _statSetProp

`Protected` _symlinkDestroy

`Protected` _unlink

`Optional` options: boolean | AddEventListenerOptions

`Optional` parent: INodeIndex

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Protected` dirSetRoot

`Optional` tran: DBTransaction

`Protected` dirUnsetRoot