/[de-setf-amqp]/amqp.asd
ViewVC logotype

Contents of /amqp.asd

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3 - (hide annotations)
Tue Feb 23 09:05:39 2010 UTC (4 years, 1 month ago) by janderson
File size: 5963 byte(s)
Merge commit 'remotes/github/master' into remotes/git-svn
1 janderson 3 ;;; -*- Mode: lisp; Syntax: ansi-common-lisp; Base: 10; Package: common-lisp-user; -*-
2    
3     (in-package :common-lisp-user)
4    
5     ;;; This file is the system definition for the 'de.setf.amqp' Common Lisp library.
6     ;;; 'de.setf.amqp' is a native Common Lisp wire-level implementation for the 'Advanced Message Queueing
7     ;;; Protocol'.
8     ;;;
9     ;;; Copyright 2010 [james anderson](mailto:james.anderson@setf.de) All Rights Reserved
10     ;;; 'de.setf.amqp' is free software: you can redistribute it and/or modify it under the terms of version 3
11     ;;; of the GNU Affero General Public License as published by the Free Software Foundation.
12     ;;;
13     ;;; 'setf.amqp' is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
14     ;;; without even the ;;; implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
15     ;;; See the Affero General Public License for more details.
16     ;;;
17     ;;; A copy of the GNU Affero General Public License should be included with 'de.setf.amqp' as `AMQP:agpl.txt`.
18     ;;; If not, see the GNU [site](http://www.gnu.org/licenses/).
19     ;;;
20     ;;; This file should reside in the root directory of the `de.setf.amqp` source files.
21     ;;; That, in turn, should be a sibling directory to the `de.setf.utility` library, from which
22     ;;; `pathnames.lisp` adds support for a system-specific logical host.
23     ;;;
24     ;;; In order to load the core system, obtain its required libraries (see below), and load it as
25     ;;;
26     ;;; (asdf:operate 'asdf:load-op :de.setf.amqp)
27     ;;;
28     ;;; In order to use the library, one must load at least one concrete protocol version. for eaxmple,
29     ;;;
30     ;;; (asdf:operate 'asdf:load-op :de.setf.amqp.amqp-1-1-0-9-1)
31     ;;;
32     ;;; Each supported versions are present as an individual sub-directory.
33     ;;;
34    
35    
36     (unless (find-package :de.setf.utility)
37     (load (merge-pathnames (make-pathname :directory '(:relative :up "utility")
38     :name "pathnames")
39     *load-pathname*)))
40    
41    
42     (de.setf.utility:set-relative-logical-pathname-translations "AMQP")
43    
44     ;;; for sbcl simple streams should be here:
45     ;;; "SYS:CONTRIB;SB-SIMPLE-STREAMS;SB-SIMPLE-STREAMS.ASD"
46     #+sbcl
47     (declaim (sb-ext:muffle-conditions sb-ext:compiler-note))
48    
49     (asdf:defsystem :de.setf.amqp
50     :nicknames (:setf.amqp)
51     :description "An AMQP client library"
52     :version "20100214-0.3"
53     :serial t
54     :depends-on (:net.common-lisp.usocket
55     :net.common-lisp.closer-mop
56     :net.common-lisp.bordeaux-threads
57     :de.weitz.cl-ppcre
58     :com.b9.puri.ppcre
59     :de.setf.utility
60     :de.setf.utility.mime
61     #+sbcl :sb-simple-streams)
62     :components ((:file "package")
63     (:file "parameters")
64     (:file "utilities")
65     (:file "amqp-uri")
66     #+(or mcl clozure)
67     (:file "extremely-simple-stream")
68     (:file "amqp-device")
69     (:file "stream")
70     (:file "data-wire-coding")
71     (:file "states")
72     (:file "macros")
73     (:file "classes")
74     (:file "frames")
75     (:file "conditions")
76     (:file "processing")
77     (:file "commands")
78     (:file "device-level")
79     (:file "device-stream"))
80    
81     :long-description
82     "`de.setf.amqp` implements a native Common Lisp client library for the 'Advanced Message Queueing
83     Protocol'. The implementation comprises wire-level codecs, implementations
84     for the standard protocol objects and methods, a functional interface for message-,
85     stream- and object-based i/o, and a device-level simple-stream implementation.
86    
87     The library targets the revisions of the published AMQP protocol as of versions
88     0.8, 0.9, and 0.10. This means that it should work with respective RabbitMQ,
89     Apache ActiveMQ, and Qpid implementations. The implementation architecture
90     should also accommodate a control structure appropriate for the prospective
91     1.0 version - as least as described in preliminary drafts.
92     For each version, a distinct package comprises the object and method
93     definitions for protocol entities and codecs as generated from the respective
94     specification documents.[1] Each collection is a
95     complete projection, which means there is some amount of duplication.
96     The package and directory names names follow more-or-less the naming conventions of the
97     xml protocol documents[2]:
98     ----------------- --------------- ---------------------------------------------
99     AMQP-1-1-0-8-0 version 0.8 [amqp0-8.xml, amqp0-8.pdf (2006-06)]
100     AMQP-1-1-0-9-0 version 0.9 [amqp0-9.xml, amqp0-9.pdf (2006-12)]
101     AMQP-1-1-0-9-1 version 0.9r1 [amqp0-9-1.xml, amqp0-9-1.pdf (2008-11-24)]
102     AMQP-1-1-0-10-0 version 0.10 [amqp.0-10.xml, amqp.0-10.pdf (2008-02-20)]
103    
104     In order to modify the translation and/or generate new codecs consult the `:de.setf.amqp.tools` component.
105    
106     All protocol versions are expressed through a common interface[3] which is specialized for the common
107     abstract classes. The initial connection phase determines the correct concrete connection implementation
108     to be used to communicate with the broker. Given which the other concrete object and method classes are
109     elected from the same package. One determines the version support directly by loading the respective
110     version's `.asd` file, which makes its connection class available for negotiation.
111    
112     ----------
113     [1]: tools/spec.lisp
114     [2]: http://www.amqp.org/confluence/display/AMQP/AMQP+Specification
115     [3]: documentation/index.html
116     ")
117    
118    
119    
120    
121     #+(or) ;; to graph the system descrition
122     (progn
123     (asdf:operate 'asdf:load-op :de.setf.utility.asdf)
124    
125     (cl-user::encode-system-graph (asdf:find-system :de.setf.amqp) #p"LIBRARY:de;setf;amqp;amqp.dot"
126     ;; :rankdir "TB"
127     :name (format nil "AMQP-~/date::format-iso-time/" (get-universal-time))
128     :properties '(:file (:components nil))))

  ViewVC Help
Powered by ViewVC 1.1.5