Changeset 86d00c1c13b8ebcac97592b43d14a122d37795db in xas-spooler


Ignore:
Timestamp:
12/21/15 16:52:06 (3 years ago)
Author:
Kevin L. Esteb <kevin@…>
Branches:
master
Children:
c52c070ba907a059a37c0d8caa9f450c3d981ec0
Parents:
b72d72d21ecb21b279719abbd51c0d6a94e8a11f
git-author:
Kevin L. Esteb <kevin@…> (12/21/15 16:52:06)
git-committer:
Kevin L. Esteb <kevin@…> (12/21/15 16:52:06)
Message:

updating documentation

Location:
trunk/lib/XAS
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/lib/XAS/Apps/Spooler/Process.pm

    rb72d72d21ecb21b279719abbd51c0d6a94e8a11f r86d00c1c13b8ebcac97592b43d14a122d37795db  
    198198=over 4 
    199199 
     200=item L<XAS::Spooler::Connector|XAS::Spooler::Connector> 
     201 
     202=item L<XAS::Spooler::Processor|XAS::Spooler::Processor> 
     203 
    200204=item L<XAS::Spooler|XAS::Spooler> 
    201205 
  • trunk/lib/XAS/Spooler.pm

    rb72d72d21ecb21b279719abbd51c0d6a94e8a11f r86d00c1c13b8ebcac97592b43d14a122d37795db  
    2222 
    2323When a process wants to send a message, it creates a spool file. The spool file 
    24 is a serialized Perl data structure in JSON format, with special headers. 
    25 The spooler scans the spool directory and sends the packet to an appropiate 
    26 queue on a message queue server. The protocol used to do this is known as 
    27 STOMP, which is a text based protocol. 
     24is a serialized Perl data structure in L<JSON|http://json.org/> format, with  
     25special headers. The spooler scans the spool directory and sends the packet  
     26to an appropriate queue on a message queue server. L<XAS::Collector|XAS::Collector>  
     27is used as the endpoint to handle those messages. The messaging protocol used  
     28by the message queue server is known as STOMP, which is a text based protocol. 
    2829 
    2930The reason to do all of this, is to decouple the message sender from the 
    3031message receiver. This simplifies the sender. There is no need to implement 
    31 all of the logic to open network conections and the maintainence of those  
     32all of the logic to open network connections and the maintenance of those  
    3233connections. It also allows for buffering of the message stream. A fast sender 
    3334doesn't have to worry about a slow receiver. The spooler takes care of this. 
     
    4344use for those packets. 
    4445 
     46The configuration file is documented here: L<XAS::Apps::Spooler::Process|XAS::Apps::Spooler::Process> 
     47 
     48=over 4 
     49 
     50=item xas-spooler --help 
     51 
     52This will display a brief help screen on command options. 
     53 
     54=item xas-xpooler --manual 
     55 
     56This will display the utilities man page. 
     57 
     58=back 
     59 
    4560=head1 SEE ALSO 
    4661 
     
    5267 
    5368=item L<XAS::Spooler::Processor|XAS::Spooler::Processor> 
     69 
     70=item L<XAS::Spooler|XAS::Spooler> 
    5471 
    5572=item L<XAS|XAS> 
Note: See TracChangeset for help on using the changeset viewer.