EMU

Revision as of 04:15, 27 April 2006 by Trickli (Talk | contribs)


  1. =Overview=
  2. ==Name==

EMU stands for Eiffel Multi User.

  1. ==Goal==

The aim of this project is to integrate a simple repository functionality into EiffelStudio.


  1. =Software Requirements Specification=
  2. ==The Parts==
  • EMU-Protocol
  • EMU-Server
  • EMU-Client
  • EMU-IDE integration
  1. ==Developer Requirements==
  2. ===EMU-Protocol===

defines Client/Server communication with

  • client/server states
  • available messages
  • client/server actions
  1. ===EMU-Server===
  • stores and manages code-repository
  • synchronizes code of clients
  • manages Locking-System
  • Account-System
  • project update
  • add/create new code (classes)
  • change-logging
  • optional: Media-upload
  • optional: BackUp-System
  • optional: Release-versions
  • optional: Server-Admin-Tool
  1. ====Locking-System====
  • list of locked code
  • check if code (class) is locked
  • lock / unlock code (class)
  1. ====Code-Synchronization====
  • broadcast code-changes
  • bring user code up to date
  1. ====Account-System====

The server uses an account-system to organize its projects and users. Every project has its own users assigned.

  1. =====Project-Accounts=====
  • project name
  • project-admin(s)
  • user lists
  • project status
  • editable / creatable with a project-admin-tool
  1. =====User-Accounts=====
  • usernames
  • used for logins
  • assign locked code & changes to users
  • online status
  1. ===Change-Log===

Every lock/unlock action is locked with following data:

  • user name
  • date and time
  • type of action
  • code element (class name)
  1. ===EMU-Client===
  • interface for IDE and server
  • provides features to login and communicate with server on an abstract base
  • upload/download code elements to/from server
  • notify IDE of server-messages (code-updates)
  • modular / independent of IDE-integration
  • optional: upload media files
  1. ====IDE-Notifications====

The client needs to notify the IDE of the new changes.

  1. ===EMU-IDE integration===
  • minimal change to existing ES-classes and features.
  • modular integration: activatable and removable / hideable


  1. ==User Requirements==
  • easy to use
  • target is a small project group of up to 20 developers.
  • code synchronisation process mostly hidden from user
  • minimal extra work (less total work)
  • better efficiency


  1. =Milestones=
  1. ==M1: April 25th==
  • set up mailinglist es-emu@origo.ethz.ch (Bernd)
  • wiki page up to date
  • everyone managed to compile Eiffelstudio
  1. ==M2: May ??? ==
  • To be completed by the team


  1. =Team=

Everyone interested in this project is welcome to join our mailinglist es-emu@origo.ethz.ch