proto-socket/templates/language/README.md
toki c384516b47 feat: implement new communication patterns and add cross-test support
- Add Transport class for unified communication layer
- Implement new communicator patterns
- Add VERSIONING.md for version management
- Add crosstest files for Dart/Go integration testing
- Update protocol documentation
- Add new skills and templates for AI-assisted development
- Various bug fixes and improvements to Dart implementation
2026-04-12 07:53:31 +09:00

41 lines
1.2 KiB
Markdown

# <Language> Toki Socket
Status: planned
This package implements Toki Socket protocol version `0.1` for <Language>.
## Required Structure
Use this package README to document the concrete files for:
- Transport abstraction: TCP, TLS+TCP, WS, and WSS implementations.
- Communicator core: parser map, listener routing, request-response correlation, and serialized writes.
- Client/server layer: connection lifecycle, close behavior, and heartbeat ownership.
- Generated protobuf bindings from `dart/lib/src/packets/message_common.proto`.
- Unit tests and cross-language tests.
## Proto Generation
Document the package-local proto generation command here. The generated schema must match the canonical Dart proto except for language-specific generator options.
```bash
# <command to generate protobuf bindings>
```
After generation, run from the repository root:
```bash
tools/check_proto_sync.sh
```
## Validation
Before marking this implementation available, document and run:
```bash
# <formatter or linter>
# <unit tests>
# <crosstest command>
```
The implementation must pass same-language tests and cross-language tests against at least one available implementation.