Metadata-Version: 2.4
Name: oaknut-econet-core
Version: 13.6.1
Summary: Core abstractions for Econet networking in the oaknut family: packet types, addressing, the EconetTransport interface, capabilities, and an in-process test transport.
Author-email: Robert Smallshire <robert@smallshire.org.uk>
License-Expression: MIT
Project-URL: Homepage, https://github.com/rob-smallshire/oaknut/tree/master/packages/oaknut-econet-core
Project-URL: Repository, https://github.com/rob-smallshire/oaknut
Project-URL: Issues, https://github.com/rob-smallshire/oaknut/issues
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: System :: Networking
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: oaknut-exception>=10.0
Requires-Dist: oaknut-extension>=10.0
Dynamic: license-file

# oaknut-econet-core

The core abstractions for Econet networking in the `oaknut` package family.

Econet was Acorn's networking technology for the BBC Micro, Master, and
Archimedes, built around the Motorola MC68B54 ADLC. This package provides the
foundation on which transports and applications are built:

- **`EconetPacket`** and **`PacketKind`** — the logical-packet currency shared by
  every transport (modelled on the AUN packet).
- **`Address`** — `(network, station)` addressing, with the well-known values
  (broadcast station, local network, immediate port).
- **`TransmitResult`** / **`TransmitOutcome`** — the fine-grained delivery outcome
  of a transmission (acknowledged, not-listening, no-clock, line-jammed, …).
- **`EconetTransport`** — the abstract, `asyncio`-native interface a transport
  implements, plus **`TransportCapability`** flags describing what a given
  transport supports.
- **`TestTransport`** — an in-process loopback transport for testing Econet
  applications without hardware or a network.

Concrete transports live in sibling packages (`oaknut-econet-aun`,
`oaknut-econet-piconet`, `oaknut-econet-hat`) and plug in through the
`oaknut.econet.transport` extension axis. Higher-level applications — a file
server, a bridge — build on this interface.

This package sits at the **logical-packet** level: the Econet four-way handshake
is resolved below the transport boundary, so applications work in whole packets,
not ADLC frames. See `docs/dev/econet-design.md` in the repository root for the
full design.
