Mirabito RLM - Enis Ozden; Korkut Balta; Muhammad Selim Albayrak;

From CS486wiki
Jump to navigationJump to search

Week 1 09/17/2024


Accomplishments:
Spent time understanding the codebase:

 * Went through the files `interface.php` and `ipconnect.php` to get familiar with their structure.
 * Summarized the overall purpose of each file.
 * Highlighted the main functions and what they are designed to do.

Identified critical elements:

 * Located the functions responsible for parsing data.
 * Identified key variables that store the parsed data.
 * Reviewed constants and predefined values used to handle different message types or fields.

Added inline documentation:

 * Wrote clear comments to explain the parts of the code we fully understood.

To-Do:

 * Continue exploring how these components interact to gain a deeper understanding of the entire system.

Week 2 09/25/2024


Accomplishments:


Worked on writing the C# codebase:

Key files writen:

*LoyaltyMessage.cs: Detailed the data models and XML serialization attributes.
*FrontendApp.cs: The client application creates and sends LoyaltyMessage objects.
*BackendApp.cs: The server application processes incoming XML data and sends it back to the sender.

Explained functionality:

*Highlighted the purpose and interaction of each class and method.
*Illustrated the flow of data between the client and server.

Enhanced understanding:

*Gained insights into XML serialization/deserialization and TCP networking.
*Reviewed asynchronous programming patterns used in the applications.

To-Do:

Refine the documentation for clarity and brevity. Add inline comments to the code for better readability. Explore implementing error handling and input validation.