recentip 0.4.0

An opinionated async SOME/IP implementation for Rust — boring by design, backed by Tokio.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

# RecentIP

[![Crate](https://img.shields.io/crates/v/recentip.svg)](https://crates.io/crates/recentip)
[![Docs](https://docs.rs/recentip/badge.svg)](https://docs.rs/recentip)
[![License: GPL-3.0](https://img.shields.io/badge/license-GPL--3.0-blue.svg)](LICENSE)

An opinionated **async and boring SOME/IP protocol implementation**.

[SOME/IP](https://some-ip.com/) (Scalable service-Oriented MiddlewarE over IP) is the standard middleware protocol for automotive Ethernet communication, enabling service-oriented communication between ECUs in modern vehicles.

Right now, this is a hobby project for exploration.
The goal is to create a solid, performant and easy-to-use and maintain SOME/IP implementation.

### **[=> Show me some examples! <=](https://docs.rs/recentip/latest/recentip/examples/quickstart/index.html)**

## Features

- Zero-panic. expect, unwrap, indexing forbidden by clippy rule
- Lock-free hot paths. Data is passed using channels for uninterrupted non-blocking flows
- Tokio-backed async. scales from single to multicore execution
- Spec compliance testsuite and report.
- Brings its own recentIP lint rule for proper usage.
- No-unsafe. forbidden by clippy rule

## Supported SOME/IP
Right now, this lib implements these core parts of the SOME/IP protocol:
- **Service Discovery** — Automatic discovery via multicast SD protocol
- **RPC** — Request/response and fire-and-forget method calls
- **Pub/Sub** — Event subscriptions with eventgroup management

## Installation

Add to your `Cargo.toml`:

```toml
[dependencies]
recentip = "0.3"
```

## Documentation

**[API Documentation](https://docs.rs/recentip)** — Configuration, API overview, and compile-checked examples

- [Quickstart examples](https://docs.rs/recentip/latest/recentip/examples/quickstart/index.html)
- [All examples](https://docs.rs/recentip/latest/recentip/examples/index.html)

## Testing

The library heavily leverages [turmoil](https://docs.rs/turmoil) for deterministic and fast network and time simulation. There are several test suites:

- Unit tests in each module
- Compliance tests in `tests/compliance` certifying compliance with the SOME/IP specs backed.
- Real network tests not using turmoil.
- API behavior tests for non-spec behavior.

```bash
# Run most tests (~15s)
cargo nextest run

# Run all tests (~15s)
cargo nextest run --cargo-profile fast-release --features slow-tests

# Generate coverage report
cargo llvm-cov nextest --features slow-tests

# Doc tests
cargo test --doc
```

## RecentIP Lints

RecentIP comes with a lint rule for detecting wrong usage of the it that cannot be enforced by types.

- The `RUNTIME_MUST_SHUTDOWN` lint warns when a `SomeIp` might be dropped without `shutdown()`.

Use the included [dylint](https://github.com/trailofbits/dylint) lint crate:

```bash
# Install dylint
cargo install cargo-dylint dylint-link

# Run lints
cargo dylint --all
```

## Specification Compliance

This implementation targets full compliance with the [open SOME/IP 2025-12 specification](https://github.com/some-ip-com/open-someip-spec/commit/dcdfbd8f772ebfa973317e3cd4580874d848ae7e). Support per requirement can be verified using the [traceability report](https://docs.rs/recentip/0.1.0-alpha.4/recentip/compliance/traceability/index.html). 

## Architecture

```
┌─────────────────────────────────────────────────────────────┐
│                      User Application                       │
│ SomeIp-Handle     OfferedService          ServiceOffering   │
└────┬────────────────────┬─────────────────────┬─────────────┘
     │                    │▲ Events             │▲ Events
     │           Commands ▼│           Commands ▼│
┌─────────────────────────────────────────────────────────────┐
│                     SomeIp (Event Loop)                     │
│   Multiplexes: commands, SD, RPC, TCP, timers               │
└─────────────────────────────────────────────────────────────┘
           │                              │
           ▼                              ▼
    ┌─────────────┐                ┌─────────────────────────┐
    │ SD Socket   │                │ Pub/Sub and RPC Sockets │
    │ UDP:30490   │                │ UDP/TCP                 │
    └─────────────┘                └─────────────────────────┘
```

Handles (`OfferedService`, `ServiceOffering`) don't perform I/O directly—they send commands to the central event loop, which owns all sockets and state.

## Not yet implemented
- SOME/IP-TP
- Encryption
- De-/Serialization
- Fields, Getter, Setter
- Configuration handling

## License

This project is licensed under the [GPL-3.0 License](LICENSE).

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md).