Module

Defined in: src/module.ts:142

Implements

• AsyncDisposable

Constructors

Constructor

new Module(init): Module

Defined in: src/module.ts:190

Note this only sets the module up. Use init to actually load it.

Parameters

init

ModuleInit

Returns

Module

Properties

_exit?

protected readonly optional _exit?: (this) => void | Promise<void>

Defined in: src/module.ts:151

Parameters

this

Module

Returns

void | Promise<void>

---

_init?

protected readonly optional _init?: (this) => void | Promise<void>

Defined in: src/module.ts:150

Parameters

this

Module

Returns

void | Promise<void>

---

_refs

_refs: number = 0

Defined in: src/module.ts:180

Internal

The number of references held on this module.

---

author?

readonly optional author?: string | string[]

Defined in: src/module.ts:148

---

description?

readonly optional description?: string

Defined in: src/module.ts:147

---

holders

readonly holders: Set<Module>

Defined in: src/module.ts:172

Modules that depend on this one

---

kobject

readonly kobject: ModuleKObject

Defined in: src/module.ts:164

---

license?

readonly optional license?: string

Defined in: src/module.ts:146

---

name

readonly name: string

Defined in: src/module.ts:143

---

params

readonly params: Map<string, KernelParam<ParamValue>>

Defined in: src/module.ts:166

---

srcversion?

readonly optional srcversion?: string

Defined in: src/module.ts:145

---

taints

readonly taints: Set<"P" | "F" | "C" | "E" | "O">

Defined in: src/module.ts:174

---

uses

readonly uses: Set<Module>

Defined in: src/module.ts:169

Modules this one depends on

---

version?

readonly optional version?: string

Defined in: src/module.ts:144

Accessors

flags

Get Signature

get flags(): string

Defined in: src/module.ts:248

The taint characters for a module, for example OE

Returns

string

---

refcnt

Get Signature

get refcnt(): number

Defined in: src/module.ts:183

The number of references held on this module, including the ones held by holders

Returns

number

---

state

Get Signature

get state(): ModuleState

Defined in: src/module.ts:155

Returns

ModuleState

Set Signature

set state(value): void

Defined in: src/module.ts:159

Parameters

value

ModuleState

Returns

void

Methods

[asyncDispose]()

[asyncDispose](): Promise<void>

Defined in: src/module.ts:327

Returns

Promise<void>

Implementation of

AsyncDisposable.[asyncDispose]

---

dispose()

dispose(force?): Promise<void>

Defined in: src/module.ts:309

Unload a module, analogous to delete_module(2).

Parameters

force?

boolean = false

Unload even when the module is still referenced. This taints the module with F.

Returns

Promise<void>

Throws

EBUSY if the module isn’t live, or is still referenced and force isn’t set

---

init()

init(): Promise<void>

Defined in: src/module.ts:227

Run init.

Unlike Linux’s init_module(2), this is async since a module may need to do something asynchronous (like fetching a resource) before it is ready. The module is init until then.

Returns

Promise<void>

Throws

Whatever init throws, after unloading the partially loaded module

---

param()

param<T>(name): T | undefined

Defined in: src/module.ts:243

Shorthand for this.params.get(name)?.value

Type Parameters

T

T extends ParamValue = ParamValue

Parameters

name

string

Returns

T | undefined

---

ref()

ref(): void

Defined in: src/module.ts:263

Like try_ref, but throws instead of returning false

Returns

void

---

try_ref()

try_ref(): boolean

Defined in: src/module.ts:256

Take a reference on a module so it can’t be unloaded.

Returns

boolean

whether the reference was taken

---

unlink()

protected unlink(): void

Defined in: src/module.ts:297

Remove from the list and tear down sysfs entries.

Returns

void

---

unref()

unref(): void

Defined in: src/module.ts:267

Returns

void

---

unuse()

unuse(target): void

Defined in: src/module.ts:286

Undo use

Parameters

target

Module

Returns

void

---

use()

use(target): void

Defined in: src/module.ts:275

Depend on target. This takes a reference on target and adds a link in /sys/module/<target>/holders.

Parameters

target

Module

Returns

void