Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
1a78b66
Add project README and sequence diagrams
VinaykumarRS1995 May 28, 2026
2dbe504
Set up Cargo project with dependencies and module structure
VinaykumarRS1995 May 28, 2026
f1ef360
Add configuration module with pluggable provider trait
VinaykumarRS1995 May 28, 2026
018e678
Define DoIP protocol data model and message types
VinaykumarRS1995 May 28, 2026
602ee28
Add PayloadHandler trait and generic dispatcher
VinaykumarRS1995 May 28, 2026
36d9971
Add SOVD proxy trait with stub and mock implementations
VinaykumarRS1995 May 28, 2026
d0bc797
Implement UDP handlers for vehicle identification and entity status
VinaykumarRS1995 May 28, 2026
762050b
Implement alive check and routing activation TCP handlers
VinaykumarRS1995 May 28, 2026
cedafae
Implement diagnostic message handler and wire dispatcher factories
VinaykumarRS1995 May 28, 2026
d8d31d2
Implement async TCP/UDP transport with DoIP framing
VinaykumarRS1995 May 28, 2026
e265972
Add session manager with RAII connection tracking
VinaykumarRS1995 May 28, 2026
5c9b43e
Wire server struct combining TCP and UDP transports
VinaykumarRS1995 May 28, 2026
e354655
Add application entry point and DoIP tester example
VinaykumarRS1995 May 28, 2026
b97d7af
Merge upstream main
VinaykumarRS1995 May 28, 2026
a0fd1bf
Address PR Initial review feedback
VinaykumarRS1995 May 29, 2026
7e4a104
refactor: Rename , Updated comments
VinaykumarRS1995 Jun 3, 2026
dd93c9f
docs(Diagrams) : imoprove DoIP sequence diagrams
VinaykumarRS1995 Jun 17, 2026
773afb8
docs(config): add rustdoc documentation and design rationale
VinaykumarRS1995 Jun 17, 2026
db87fee
docs: reorganize architecture and sequence diagrams
VinaykumarRS1995 Jun 19, 2026
41c22e7
docs: add architecture, usage and project documentation
VinaykumarRS1995 Jun 19, 2026
2714214
Rustdoc : Rust doc update
VinaykumarRS1995 Jun 19, 2026
ce5f702
README.md updates
rpreddyhv Jul 7, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# SPDX-License-Identifier: Apache-2.0
# SPDX-FileCopyrightText: 2026 The Contributors to Eclipse OpenSOVD (see CONTRIBUTORS)
# Copyright (c) 2026 The Contributors to Eclipse OpenSOVD (see CONTRIBUTORS)
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
#
# This program and the accompanying materials are made available under the
# terms of the Apache License Version 2.0 which is available at
# https://www.apache.org/licenses/LICENSE-2.0
#
# SPDX-License-Identifier: Apache-2.0

.env
.cache
Expand Down
45 changes: 42 additions & 3 deletions CODESTYLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,28 @@ https://www.apache.org/licenses/LICENSE-2.0

# Code Style Guide

## Quick Links

- **View API Documentation** (recommended):
```sh
cargo doc-lib
```
Opens the main library documentation with architecture overview, diagrams, and all modules

- **View All Workspace Crates** (no dependencies):
```sh
cargo doc-all
```
Shows doipserverlib, doip-server, and Example (test client) — no external dependency docs

- **View All with Dependencies**:
```sh
cargo doc-full
```
Includes all external dependency documentation (verbose)

Available cargo aliases are defined in `.cargo/config.toml`

## Linting & Clippy

- **Clippy**: Always run with `clippy::pedantic` enabled for stricter linting.
Expand Down Expand Up @@ -79,7 +101,24 @@ Additionally the import granularity is set to `crate` to group all imports from

## Documentation

- Document all public items with `///` doc comments.
- Use clear, concise language and provide context for complex logic.
### Rustdoc Standards

- **Module-level documentation**: All public modules must have `//!` comments explaining:
- Purpose and role of the module
- Key types and functions
- Relationships to other modules (if helpful)

- **Public items**: All public structs, enums, traits, and functions must have `///` documentation:
- Explain *what* the item does and *when* it should be used
- Include an "# Errors" section for fallible operations
- Add "# Example" sections only where usage patterns aren't obvious

- **Language and clarity**:
- Use clear, concise language without unnecessary verbosity
- Avoid long paragraphs; prefer short, focused explanations
- Link to existing architecture documents instead of duplicating large explanations

---
- **Build documentation locally**:
```sh
cargo doc --no-deps --open
```
10 changes: 0 additions & 10 deletions CONTRIBUTORS

This file was deleted.

Loading