Changeset d42dc6b76aa5cb6d818bceb3ae91fc615b2b8bd2 in xas-supervisor


Ignore:
Timestamp:
12/16/15 14:27:25 (3 years ago)
Author:
Kevin L. Esteb <kevin@…>
Branches:
master
Children:
34b5c7e6f67dbcb27f3658fe4aa52841c1003c03
Parents:
53b723f1a24444cfad52d710d636e41123ecc19b
git-author:
Kevin L. Esteb <kevin@…> (12/16/15 14:27:25)
git-committer:
Kevin L. Esteb <kevin@…> (12/16/15 14:27:25)
Message:

updating documentation

Files:
7 edited

Legend:

Unmodified
Added
Removed
  • README.md

    r060cc7e635d3538a55eba919ca2accfc9fb60b52 rd42dc6b76aa5cb6d818bceb3ae91fc615b2b8bd2  
    1616details. 
    1717 
    18 <additonal details go here> 
     18The package provides a robust supervisor to maintain background processes. 
     19There is also a command line control procedure that allows you to start, 
     20stop, pause, resume and kill managed processes. This is primarily 
     21intended for Unix platforms. It can run under Windows, but the SCM 
     22already has some supervisory features build in. 
    1923 
    2024Extended documentation is available at: http://scm.kesteb.us/trac 
  • trunk/lib/XAS/Apps/Supervisor/Client.pm

    r6b8f06066239d5c2a2858da48efa71656ebdbfec rd42dc6b76aa5cb6d818bceb3ae91fc615b2b8bd2  
    166166=over 4 
    167167 
     168=item L<XAS::Supervisor::Client|XAS::Supervisor::Client> 
     169 
    168170=item L<XAS::Supervisor|XAS::Supervisor> 
    169171 
  • trunk/lib/XAS/Apps/Supervisor/Monitor.pm

    r791e58164dd85cd9f9dcc7dcd0ea3f8337b61504 rd42dc6b76aa5cb6d818bceb3ae91fc615b2b8bd2  
    101101=head2 options 
    102102 
    103 This method defines the command line options. 
     103These are the additional options. 
     104 
     105=over 4 
     106 
     107=item B<--port> 
     108 
     109This defines the port to list on. Defaults to RPC_DEFAULT_PORT. 
     110 
     111=item B<--address> 
     112 
     113This defines the address to bind too. Defaults to RPC_DEFAULT_ADDRESS. 
     114 
     115=back 
    104116 
    105117=head1 SEE ALSO 
    106118 
    107119=over 4 
     120 
     121=item L<XAS::Supervisor::Controller|XAS::Supervisor::Controller> 
     122 
     123=item L<XAS::Supervisor::Monitor|XAS::Supervisor::Monitor> 
    108124 
    109125=item L<XAS::Supervisor> 
  • trunk/lib/XAS/Supervisor.pm

    r6b8f06066239d5c2a2858da48efa71656ebdbfec rd42dc6b76aa5cb6d818bceb3ae91fc615b2b8bd2  
    1414XAS::Supervisor - A set of modules and procedures to supervise processes 
    1515 
    16 =head1 SYNOPSIS 
    17  
    1816=head1 DESCRIPTION 
    1917 
    20 A superivsor is a process that manages other processes. This package provides 
    21 this capability for XAS.  
     18A superivsor is a process that manages other processes. On Unix this would be 
     19similar to init, which is the master process.  
     20 
     21=head2 xas-supervisor 
     22 
     23This is the control process. It reads a configuration file to see what  
     24processes to start. Once they are started, the supervisor will make sure that  
     25they continue to run.  
     26 
     27When a process exits, the supervisor checks the exit status. If that status is 
     28known, it will restart the process otherwise it will send alert that the process 
     29has stopped. 
     30 
     31=head2 xas-supctl 
     32 
     33This is a command line tool to communicate with the supervisor. With this 
     34tool you can stop, start, pause, resume or kill a managed process. You  
     35can also retrieve all of the processes that the supervisor knows about and 
     36you can check the status of individual processes. 
    2237 
    2338=head1 SEE ALSO 
  • trunk/lib/XAS/Supervisor/Client.pm

    r6b8f06066239d5c2a2858da48efa71656ebdbfec rd42dc6b76aa5cb6d818bceb3ae91fc615b2b8bd2  
    171171=head1 DESCRIPTION 
    172172 
    173 This is the client module for external access to the XAS Supervisor.  
     173This is the client module for RPC access to the XAS Supervisor.  
    174174 
    175175=head1 METHODS 
     
    266266=over 4 
    267267 
     268=item L<XAS::Supervisor::Controller|XAS::Supervisor::Controller> 
     269 
     270=item L<XAS::Supervisor::Monitor|XAS::Supervisor::Monitor> 
     271 
    268272=item L<XAS::Supervisor|XAS::Supervisor> 
    269273 
  • trunk/lib/XAS/Supervisor/Controller.pm

    r6b8f06066239d5c2a2858da48efa71656ebdbfec rd42dc6b76aa5cb6d818bceb3ae91fc615b2b8bd2  
    334334=head1 DESCRIPTION 
    335335 
     336This module provides a RPC interface to the supervisor. This interface allows 
     337external access to stop, start, pause, resume and kill processes. It also 
     338provides a means to to retrieve the status of a process and to list all the 
     339known processes. 
    336340 
    337341=head1 METHODS 
    338342 
    339 =head2 method1 
     343=head2 new 
     344 
     345This module inherits from L<XAS::Lib::JSON::RPC::Server|XAS::Lib::JSON::RPC::Server> 
     346and takes all of the same parameters. 
     347 
     348=head2 session_initialize 
     349 
     350This method sets up the process for the rpc calls. 
     351 
     352=head2 check_status 
     353 
     354This method starts a background task to check the status of RPC calls.  
     355 
     356=head1 RPC CALLS 
     357 
     358The following rpc calls are supported. L<XAS::Supervisor::Client|XAS::Supervisor::Client> 
     359has this interface already defined and should be used when writting new code. 
     360 
     361=head2 start_process 
     362 
     363This will start a process. The rpc parameters should use 'name' with the  
     364processes name. If the start was successful, "running" will be returned. 
     365 
     366=head2 stop_process 
     367 
     368This will stop a process. The rpc parameters should use 'name' with the  
     369processes name. If the stop was successful, "stopped" will  
     370be returned. 
     371 
     372=head2 pause_process 
     373 
     374This will pause a process. The rpc parameters should use 'name' with the  
     375processes name. If the pause was successful, "paused" will  
     376be returned. 
     377 
     378=head2 resume_process 
     379 
     380This will resume a process. The rpc parameters should use 'name' with the  
     381processes name. If the resume was successful, "running" will  
     382be returned. 
     383 
     384=head2 kill_process 
     385 
     386This will kill a process. The rpc parameters should use 'name' with the  
     387processes name. If the kill was successful, "killed" will  
     388be returned. 
     389 
     390=head2 stat_process 
     391 
     392This will perform an OS level stat on the process. The rpc parameters should  
     393use 'name' with the processes name. It will return one of the 
     394following. 
     395 
     396 'suspended ready' 
     397 'suspended blocked' 
     398 'blocked' 
     399 'running' 
     400 'ready' 
     401 'other' 
     402 'unknown' 
     403 
     404=head2 list_process 
     405 
     406This will return a list of all the processes that the supervisor knows of. 
    340407 
    341408=head1 SEE ALSO 
    342409 
    343410=over 4 
     411 
     412=item L<XAS::Supervisor::Client|XAS::Supervisor::Client> 
     413 
     414=item L<XAS::Supervisor::Monitor|XAS::Supervisor::Monitor> 
    344415 
    345416=item L<XAS::Supervisor|XAS::Supervisor> 
  • trunk/lib/XAS/Supervisor/Monitor.pm

    r53b723f1a24444cfad52d710d636e41123ecc19b rd42dc6b76aa5cb6d818bceb3ae91fc615b2b8bd2  
    152152 redirect = 0 
    153153 
    154 Please see L<XAS::Lib::Process|XAS::Lib::Process> for more details. 
     154Please see L<XAS::Lib::Process|XAS::Lib::Process> for more details. If  
     155"redirect" is 1, all output from that process will be written to the 
     156supervisors log file. 
    155157 
    156158=head1 METHODS 
     
    169171 
    170172=over 4 
     173 
     174=item L<XAS::Supervisor::Client|XAS::Supervisor::Client> 
     175 
     176=item L<XAS::Supervisor::Controller|XAS::Supervisor::Controller> 
    171177 
    172178=item L<XAS::Supervisor|XAS::Supervisor> 
Note: See TracChangeset for help on using the changeset viewer.