Difference: ProjectDesignDocGG (1 vs. 7)

Revision 72011-03-14 - RicardoRodriguez

Line: 1 to 1
 
META TOPICPARENT name="GrantGipsonCAP"

Revision History

Revision 62011-03-06 - GrantGipson

Line: 1 to 1
 
META TOPICPARENT name="GrantGipsonCAP"

Revision History

Line: 115 to 115
 
Component Path
Configuration File /var/cap/capconf.xml
<-- /editTable -->
Changed:
<
<
Master Program /usr/lib/cap/capmaster
CAP Manage /usr/lib/cap/CAPManage
Archiver /usr/lib/cap/caparchive
Downloader /usr/lib/cap/capdownload
>
>
Master Program /usr/bin/capmaster
CAP Manage /usr/bin/CAPManage
Archiver /usr/bin/caparchive
Downloader /usr/bin/capdownload
 
File Space /var/cap/
Logs /var/log/
Pipes /var/run/cap/

Revision 52011-03-05 - GrantGipson

Line: 1 to 1
 
META TOPICPARENT name="GrantGipsonCAP"

Revision History

Line: 10 to 10
 
2.2 Grant Gipson Added Python scripts to design 02/10/11
2.3 Guess who... Elaborated on Master Program and associated pipe messages 02/13/11
2.3.1   Further details; added psuedocode 02/15/11
Added:
>
>
2.3.2   Elaborated on Master Program 03/05/11
 

1. Introduction

1.1 Purpose

Line: 97 to 98
  Log Files
Changed:
<
<
capmaster.log
Anything and everything from Master Program gets logged here. Format will be date, time and short description of entry.
>
>
capmaster.log
Anything and everything from Master Program gets logged here. Format is "[MM/DD/YYYY HH:MM] -<entry priority>- <message>". The entry priority is a single character indicating the type of entry made; FATAL ERROR, ERROR, WARNING, INFORMATION, UNKNOWN.
 
Changed:
<
<
capweb.log
Anything and everything from Python CGI scripts gets logged here.
>
>
capweb.log
Anything and everything from Python CGI scripts gets logged here. Same format as above.
  Pipes
Changed:
<
<
capman.fifo
Used for communications between CAPManage and Master Program.
>
>
man2master.fifo, master2man.fifo
Used for communications between CAPManage and Master Program.
 
Changed:
<
<
webmas.fifo
Used for communications between web server and Master Program.
>
>
web2master.fifo, master2web.fifo
Used for communications between web server and Master Program.
  Component Locations
Line: 122 to 123
 
Logs /var/log/
Pipes /var/run/cap/
Client plug-in Install /var/www/
Added:
>
>
Master Program PID /var/run/cap.pid
 

5.2 Master Program

Description

Line: 130 to 132
  The Master Program will have the location of the configuration file passed to it when it starts. The configuration file will specify the locations and names of other components the program must manage. If the Master Program is unable to read the configuration file or open a log file, then it will terminate. If it does not know where anything is or it cannot report problems, then it should be stopped from operating. Master_Program_Pseudocode.txt
Added:
>
>
Command line: capmaster pid capconf.xml

The caller must specify the location of the master program's process ID (PID) file which is used to ensure that only one instance of the process is running. The second argument is the location of the XML configuration file for the system.

 Messages

MSG_MASTERHERE [out]
Sent to web server when Master Program starts.

Revision 42011-02-16 - GrantGipson

Line: 1 to 1
 
META TOPICPARENT name="GrantGipsonCAP"

Revision History

Line: 9 to 9
 
2.1 Grant Gipson Elaborated on database schema; user table in particular 02/07/11
2.2 Grant Gipson Added Python scripts to design 02/10/11
2.3 Guess who... Elaborated on Master Program and associated pipe messages 02/13/11
Added:
>
>
2.3.1   Further details; added psuedocode 02/15/11
 

1. Introduction

1.1 Purpose

Line: 125 to 126
  Description
Changed:
<
<
Acts as the coordinator of the entire system; whenever a data-changing action needs to be carried out, then it must go through the master program. The program will be one process which runs through a perpetual loop reading various pipes and responding to the data in each. The main loop will maintain a constant connection to the database so that changes can be made quickly, and reflected in the web interface.
>
>
Acts as the coordinator of the entire system; whenever a data-changing action needs to be carried out, then it must go through the master program. The program will be one process which runs through a perpetual loop reading various pipes and responding to the data in each. The main loop will maintain a constant connection to the database so that changes can be made quickly, and reflected in the web interface. Only one instance of the program will be running at a time.

The Master Program will have the location of the configuration file passed to it when it starts. The configuration file will specify the locations and names of other components the program must manage. If the Master Program is unable to read the configuration file or open a log file, then it will terminate. If it does not know where anything is or it cannot report problems, then it should be stopped from operating. Master_Program_Pseudocode.txt

  Messages
Line: 286 to 288
 PROG, used to get user's job progress. When sent from client, contains nothing. When sent from server, contains JobsProgress class specified in Client plug-in definition.

TODO: When message is of type AUTH, it must be encrypted.

Added:
>
>

5.11 Piped message format

Messages will be parsed by lines; a line is terminated by a newline character with ASCII code 0xA. Rather than have a message end with a certain character, it is better to specify the length of the message in a pre-determined line so that the contents of the message are not limited.

Messages will follow this format:

A message header indicating the nature of the message; single word, all caps. and underscores (ex: MSG_QUIT)
An unsigned long integer indicating the length of the message body
The message body which may contain any sort of data, or no data

 

6. User Interface Design

6.1 Common Appearance and Behavior

Line: 384 to 393
 
META FILEATTACHMENT attachment="CAP_system.png" attr="" comment="System Architecture Diagram 1.0" date="1297565935" name="CAP_system.png" path="CAP system.png" size="50383" stream="CAP system.png" tmpFilename="/usr/tmp/CGItemp39406" user="GrantGipson" version="1"
META FILEATTACHMENT attachment="Client_plug-in.pdf" attr="" comment="Client plug-in Interface Diagram 1.0" date="1297565985" name="Client_plug-in.pdf" path="Client plug-in.pdf" size="99545" stream="Client plug-in.pdf" tmpFilename="/usr/tmp/CGItemp39389" user="GrantGipson" version="1"
META FILEATTACHMENT attachment="Web_interface.pdf" attr="" comment="Web Interface Diagram 1.0" date="1297566031" name="Web_interface.pdf" path="Web interface.pdf" size="140996" stream="Web interface.pdf" tmpFilename="/usr/tmp/CGItemp39435" user="GrantGipson" version="1"
Added:
>
>
META FILEATTACHMENT attachment="Master_Program_Pseudocode.txt" attr="" comment="Master Program Pseudocode v. 1.0" date="1297826878" name="Master_Program_Pseudocode.txt" path="Master Program Pseudocode.txt" size="916" stream="Master Program Pseudocode.txt" tmpFilename="/usr/tmp/CGItemp43530" user="GrantGipson" version="1"

Revision 32011-02-14 - GrantGipson

Revision 22011-03-14 - TWikiGuest

Revision 12011-03-14 - TWikiGuest

Line: 1 to 1
 
This site is powered by the TWiki collaboration platformCopyright &© by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback