Project

General

Profile

Functional definition » History » Revision 7

Revision 6 (Greg Burri, 12/22/2008 09:20 AM) → Revision 7/57 (Greg Burri, 01/01/2009 11:05 PM)

h1. Functional definition 

 This page will describes the scope and utilization of Aybabtu. 
 Some sections will describe a particular window from the user interface, it may refer to the [[GUI]] page. 


 h2. Description 

 Aybabtu come with two executables, the Core and the GUI. It possible to launch one of them alone or both together. The GUI is needed to command a Core, to tell it what you want to download, to share, to search, etc. To do that the user have to tell the GUI to connect to a given Core. The Core can be _local_ or _remote_, by default the GUI will try to connect to a local Core. If the connecting attempt to a local Core failed it will try to launch a local Core and connect to it. Core. 

 The simple usage of Aybabtu is to launch the GUI which will automatically launch the Core. The user may not know there is two distinct process. The core will display an icon in the tray icon (if a tray icon exists). If the user close the GUI the core will continue to run, if he want to stop the core he have to invoke a contextual menu from the tray icon and choose _Close the Core_. The user can launch the GUI core by double-clicking under the tray icon. 

 To connect to a remote Core, the user have to explicitly enter an IP address and a password. The password is mandatory for a remote Core. For one Core it cannot be more than one GUI connected (this limitation may be removed in further version of Aybabtu). 

 The [[GUI]] shows some default windows, a download windows, an upload window and a chat window. The others windows are the search window, the browse window and the options window. All of them are described in the sections below. 

 h3. Downloading 

 You can download file or entire folder from the searching windows or from the browsing windows. The item will be enqueued to the download list and displayed in the download window. 

 When downloading a folder all theirs containing folders and files will be downloaded recursively. The path will be preserved and recreated in the machine of the downloading peer. 

 When a file or a directory is being downloaded its name will finished by the tag ".unfinished". For example "my movie.mkv.unfinished". 


 h2. The main window 

 At the first launch of Aybabtu it will connect to all peers in the LAN and show them in a panel to the left. The information show for a peer are its name and its amount of sharing. To view the peer files of a peer you have to double-click in its name or to invoke the action "browse" from the contextual menu. 

 Above the peer list there is an input box for file searching. You can write something and hit 'return', a new search window will be created and displayed. Each known peer will be asked and the list is filled as a respond is received. You can change the pattern into the search window and relaunch the search. window. You can have as many search window as you want. 


 h2. The download window 

 * Recursive folder downloading. 
 * The download windows shows paths of the downloading files and also are recreated in the queued downloading peer. 
 * The files and that are currently downloaded have the completed files. 

 Here final size with a name like "movie.mkv.unfinished". The ".unfinished" will be removed when the download is an ordered list of finished. Maybe do the differents same thing that this for folder. 

 h2. The download window shows. 
 # The complete files. 
 # The incomplete files  


 

 * The list is ordered, first the complete downloads then the incomplete ones with 0 peers then the current downloading files and finally the queued files and folders. 
 * The list can contains both file or folder, when a folder is downloaded its files and folders are retrieved from the peer and will replace the folder in the list (lazy download). 
 * There is a limit of the number of complete download. 500 for example. 

 h2. The upload window 

 h2. The chat window 

 h2. The browse window 

 h2. The search window 

 h2. The options window