Skip to content

Commit 61f5c49

Browse files
committed
Clarify the purpose of DriverInterface
1 parent 19adb0f commit 61f5c49

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/source/drivers.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ Drivers in Jumpstarter consist of three components:
1515

1616
- `Driver` - Implements the logic to configure and use the interface(s) provided
1717
by the host system. e.g. a TCP port.
18-
- `DriverInterface` - Defines the contract between the driver client and the
19-
driver itself.
18+
- `DriverInterface` - Optionally defines the contract between the driver client and the
19+
driver itself, so multiple drivers can share the same client.
2020
- `DriverClient` - Provides a user-friendly interface that can be used byclients
2121
to interact with the underlying `Driver` either locally or remotely over the network.
2222

@@ -25,8 +25,8 @@ The exporter instance runs the `Driver` itself to interact with the hardware.
2525
Clients use a `DriverClient` class to interact with the driver through the
2626
contract defined in the `DriverInterface`.
2727

28-
When a client connects to the exporter and requests a lease, a session is created
29-
for each set of tests to execute. Within the session, the specified `Driver`
28+
When a client requests a lease and connects to the exporter, a session is created
29+
for all the tests the client has to execute. Within the session, the specified `Driver`
3030
subclass is instantiated for each of the configured interfaces defined in the
3131
exporter configuration. These driver instances live throughout the duration of
3232
the session and can run setup/teardown logic and keep state internally for that

0 commit comments

Comments
 (0)