University-of-Basel-Studentprojects/Programmierprojekt
Archived
1
0
Fork 0
Code Issues 17 Pull Requests Actions Wiki Activity

Update and extend server side networking documentation #86

New Issue
Closed
opened 2026-04-10 17:26:11 +02:00 by lars.winzer · 7 comments
lars.winzer commented 2026-04-10 17:26:11 +02:00 (Migrated from git.scicore.unibas.ch)
Copy Link
Copy Source

Task

Summary

The server-side networking is only partially covered by elaborating on the commands and providing a guide on how to implement new ones.

Other key components are undocumented, with the exception of JavaDoc in the source code.

Context

Server-side documentation of various networking components

Current Progress

  • Transport (Transport Layer, Java TCP Socket, ...)
  • Sessions (Session with Reader and Writer worker thread, SessionManager, ...)
  • Protocol
    • Parsing (ProtocolParser and Tokenizer)
    • Request (PrimitiveRequest, RequestParameterAccessor)
    • Response (Response, ResponseBuilder and ResponseDispatcher)
  • Events (EventBus and Events)
  • Infrastructure part of Commands
    • Parsing (CommandParser, CommandParserDispatcher, HandlerCheck and CommandHandlerExecutor)
    • Execution (CommandHandler and CommandRouter)

Notes

I decided not to divide it into multiple sub-tasks, and therefore partial-branches, as the scope is limited.

Checklist

  • I outlined checkpoints describing phases of my work related to this task
  • I added relevant labels
  • I linked to other issues or branches that must be completed first
## Task <!--The reccommended type is: Task--> ### Summary The server-side networking is only partially covered by elaborating on the commands and providing a guide on how to implement new ones. Other key components are undocumented, with the exception of JavaDoc in the source code. ### Context Server-side documentation of various networking components ### Current Progress - [ ] Transport (Transport Layer, Java TCP Socket, ...) - [ ] Sessions (Session with Reader and Writer worker thread, SessionManager, ...) - [ ] Protocol * [ ] Parsing (ProtocolParser and Tokenizer) * [ ] Request (PrimitiveRequest, RequestParameterAccessor) * [ ] Response (Response, ResponseBuilder and ResponseDispatcher) - [ ] Events (EventBus and Events) - [ ] Infrastructure part of Commands * [ ] Parsing (CommandParser, CommandParserDispatcher, HandlerCheck and CommandHandlerExecutor) * [ ] Execution (CommandHandler and CommandRouter) ### Notes I decided not to divide it into multiple sub-tasks, and therefore partial-branches, as the scope is limited. ### Checklist - [x] I outlined checkpoints describing phases of my work related to this task - [x] I added relevant labels - [x] I linked to other issues or branches that must be completed first
lars.winzer commented 2026-04-10 17:26:11 +02:00 (Migrated from git.scicore.unibas.ch)
Copy Link
Copy Source

assigned to @lars.winzer

assigned to @lars.winzer
lars.winzer commented 2026-04-10 17:27:13 +02:00 (Migrated from git.scicore.unibas.ch)
Copy Link
Copy Source

created branch chore/networking-documentation to address this issue

created branch [`chore/networking-documentation`](/cs108-fs26/Gruppe-13/-/compare/main...chore%2Fnetworking-documentation) to address this issue
lars.winzer commented 2026-04-10 22:47:38 +02:00 (Migrated from git.scicore.unibas.ch)
Copy Link
Copy Source

Deleted branch as it does not contain the task number.

New branch will be created as soon as I start working on it

Deleted branch as it does not contain the task number. New branch will be created as soon as I start working on it
lars.winzer commented 2026-04-11 15:22:01 +02:00 (Migrated from git.scicore.unibas.ch)
Copy Link
Copy Source

changed the description

changed the description
lars.winzer commented 2026-04-11 15:22:17 +02:00 (Migrated from git.scicore.unibas.ch)
Copy Link
Copy Source

This task will be moved in Milestone 5.

This task will be moved in Milestone 5.
lars.winzer commented 2026-04-11 15:28:58 +02:00 (Migrated from git.scicore.unibas.ch)
Copy Link
Copy Source

changed start date to April 14, 2026

changed start date to April 14, 2026
lars.winzer commented 2026-04-27 01:10:55 +02:00 (Migrated from git.scicore.unibas.ch)
Copy Link
Copy Source

Task will be moved to Milestone 6

Task will be moved to Milestone 6
lars.winzer (Migrated from git.scicore.unibas.ch) closed this issue 2026-05-17 10:40:30 +02:00
This repo is archived. You cannot comment on issues.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
achievement
Tasks related to milestone achievements
 bug
Issues related to programming errors on both client and server
 ci
Issues related to problems with the gitlab ci (incorrect or missing jobs)
 client
Issues (To-Dos and tasks) related to the client
 commands
Issues and tasks related to commands and thier infrastructure (CommandHandler, CommandParser, ...)
 documentation
Issues related to the documentation (for new or unclear, incorrect or incomplete entries)
 enhancement
Issues related to enhancements (also known as feature-requests)
 game-engine
Issues related to the game engine (incorrect state transitions or move validations)
 linting
Issues related to linting i.e. false detections, too generous linting, ...
 messages
Issues and tasks related to the messages and chats
 network
Issues and tasks related to the network (SessionReader / SessionWriter, Parser, ResponseBody, ...)
 outreach
Issues and tasks related to the outreach website and everything directly related to it
 server
Issues (To-Dos and tasks) related to the server
 task
Issues outlining and discussing a general task or implementation
 templates
Issues related to GitLab templates
 ui
Issues and tasks related to the client-side ui
 unit-test
Issues related to missing or already planned unit tests
 user
Issues and tasks related to the user management
No Label documentation task
Milestone
No items
No Milestone Milestone 6
Assignees
Clear assignees
lars-winzer (Lars Winzer)
No Assignees
1 Participants
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: University-of-Basel-Studentprojects/Programmierprojekt#86
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?