Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the architecture.service-provider Reference Manual, version 0.6.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Feb 19 19:19:04 2020 GMT+0.
| • Introduction | What architecture.service-provider is all about | |
| • Systems | The systems documentation | |
| • Modules | The modules documentation | |
| • Files | The files documentation | |
| • Packages | The packages documentation | |
| • Definitions | The symbols documentation | |
| • Indexes | Concepts, functions, variables and data types |
#+TITLE: architecture.service-provider README
#+AUTHOR: Jan Moringen
#+EMAIL: jmoringe@techfak.uni-bielefeld.de
#+DESCRIPTION: Framework for defining, introspecting and using services and providers of such
#+KEYWORDS: common lisp, architecture, service, provider, framework
#+LANGUAGE: en
#+OPTIONS: H:2 num:nil toc:t \n:nil @:t ::t |:t ^:t -:t f:t *:t <:t
#+OPTIONS: TeX:t LaTeX:t skip:nil d:nil todo:t pri:nil tags:not-in-toc
* Introduction
In software architectures, a common feature is parametrization of
algorithms or protocols with higher order functions or classes and
generic functions complying to a certain protocol. These places of
potential variations can be thought of as requiring a certain
service which can be provided by arbitrary providers (See [[*Java
Service Provider Interface]] for a related approach).
# are sometimes called "extension points".
While Common Lisp supports these designs very well on a language
level (via symbols naming functions, first class functions,
=cl:make-instance=, etc.), it is often useful to go a little bit
beyond these builtin features:
* It is considered good practice to use something like
=make-test-result-formatter= instead of letting clients call
=cl:make-instance= directly.
* It is sometimes desirable to be able to enumerate all known
providers of a given service.
* Compile-time analysis of provider instantiation requests can
reveal errors early or enable transformation into more efficient
code.
* Service providers can be loaded lazily when they are instantiated.
This system adds first class services and service providers to
facilitate use cases like the above while trying to avoid conceptual
mismatches with the builtin mechanisms.
#+ATTR_HTML: :alt "build status image" :title Build Status :align right
[[https://travis-ci.org/scymtym/architecture.service-provider][https://travis-ci.org/scymtym/architecture.service-provider.svg]]
* Tutorial
** Defining a Service
In the simplest case, a service is a named collection of providers
with an optional documentation string:
#+BEGIN_SRC lisp :results value :exports both
(service-provider:define-service my-service
(:documentation
"Providers of this service do stuff."))
#+END_SRC
#+RESULTS:
#+begin_example
#
#+end_example
** Registering a Provider
A provider of a service can be anything for which a method on
=service-provider:make-provider=, and optionally
=service-provider:make-provider-form=, is defined.
For the common cases in which a provider instantiates a class or
calls a functions, the builtin provider classes
=service-provider:class-provider= and
=service-provider:function-provider= can be used. The easiest way
to register providers of these two kinds are the functions
=service-provider:register-provider/class= and
=service-provider:register-provider/function= respectively.
For example, registering a class as a provider of a service can be
accomplished like this:
#+BEGIN_SRC lisp :results value :exports both
(defclass my-class ()
((foo :initarg :foo)))
(service-provider:register-provider/class 'my-service 'my-class)
#+END_SRC
#+RESULTS:
#+begin_example
#
#+end_example
** Instantiating a Provider
The primary way to instantiate a service provider is
=service-provider:make-provider= which resembles =cl:make-instance=
but takes a service and a provider designator instead of a class
designator:
#+BEGIN_SRC lisp :results value :exports both
(service-provider:make-provider 'my-service 'my-class :foo 1)
#+END_SRC
#+RESULTS:
#+begin_example
#
#+end_example
** Introspecting a Service
Introspection of services works much like CLOS introspection: after
retrieving a service object, reader functions as well as
=cl:describe= and =cl:documentation= can be applied to it:
#+BEGIN_SRC lisp :results output :exports both
(let ((service (service-provider:find-service 'my-service)))
(print (list (service-provider:service-name service)
(service-provider:service-providers service)))
(fresh-line)
(describe service)
(fresh-line)
(print (documentation service t)))
#+END_SRC
#+RESULTS:
#+begin_example
(MY-SERVICE (#))
#
Providers:
#
"Providers of this service do stuff."
#+end_example
** Compilation
The system has some support for detecting uses of non-existent
services and providers at compile-time. In particular, the
=service-provider:make-provider= function can signal
=cl:style-warning= s when service and/or provider arguments are
constant and do not designate existing services or providers:
#+BEGIN_SRC lisp :results output :exports both
(handler-bind ((warning (lambda (condition)
(format t "~S:~%~2@T~A~%"
(type-of condition) condition))))
(compile nil '(lambda ()
(service-provider:make-provider :no-such-service :provider)))
(compile nil '(lambda ()
(service-provider:make-provider 'my-service :no-such-provider))))
#+END_SRC
#+RESULTS:
#+begin_example
SERVICE-PROVIDER:MISSING-SERVICE-WARNING:
No service is known for the designator :NO-SUCH-SERVICE.
SERVICE-PROVIDER:MISSING-PROVIDER-WARNING:
No provider of service # is
known for the designator :NO-SUCH-PROVIDER.
#+end_example
** TODO Efficiency Considerations
* Dictionary
#+begin_src lisp :results none :exports none :session "doc"
(ql:quickload '(:architecture.service-provider :alexandria :split-sequence))
(defun doc (symbol kind)
(let* ((lambda-list (sb-introspect:function-lambda-list symbol))
(string (documentation symbol kind))
(lines (split-sequence:split-sequence #\Newline string))
(trimmed (mapcar (alexandria:curry #'string-left-trim '(#\Space)) lines)))
(format nil "~(~A~) ~<~{~A~^ ~}~:@>~2%~{~A~^~%~}"
symbol (list lambda-list) trimmed)))
#+end_src
** Service Protocol
The following generic functions operate on service objects:
#+BEGIN_SRC lisp :results value :exports results :session "doc"
(doc 'service-provider:service-name 'function)
#+END_SRC
#+RESULTS:
#+begin_example
service-name SERVICE
Return the symbol which is the name of SERVICE.
#+end_example
#+BEGIN_SRC lisp :results value :exports results :session "doc"
(doc 'service-provider:service-providers 'function)
#+END_SRC
#+RESULTS:
#+begin_example
service-providers SERVICE
Return a sequence of the providers of SERVICE.
#+end_example
#+BEGIN_SRC lisp :results value :exports results :session "doc"
(doc 'service-provider:service-providers/alist 'function)
#+END_SRC
#+RESULTS:
#+begin_example
service-providers/alist SERVICE
Return the providers of SERVICE as an alist in which CARs are
provider names and CDRs are the corresponding provider objects.
#+end_example
#+BEGIN_SRC lisp :results value :exports results :session "doc"
(doc 'service-provider:service-providers/plist 'function)
#+END_SRC
#+RESULTS:
#+begin_example
service-providers/plist SERVICE
Return the providers of SERVICE as a plist in which keys are
provider names and values are the corresponding provider
objects.
#+end_example
The following generic functions query and manipulate the global set
of services:
#+BEGIN_SRC lisp :results value :exports results :session "doc"
(doc 'service-provider:find-service 'function)
#+END_SRC
#+RESULTS:
#+begin_example
find-service NAME &KEY IF-DOES-NOT-EXIST
Find and return the service designated by the `service-designator'
NAME.
IF-DOES-NOT-EXIST controls the behavior in case the designated
service cannot be found:
The values #'error and 'error cause a `missing-service-error' to
be signaled.
The values #'warn and 'warn cause a `missing-service-warning' to
be signaled and nil to be returned.
The value nil causes nil to be returned without any conditions
being signaled.
`retry' and `use-value' restarts are established around error
signaling (if IF-DOES-NOT-EXIST mandates that).
#+end_example
#+BEGIN_SRC lisp :results value :exports results :session "doc"
(doc '(setf service-provider:find-service) 'function)
#+END_SRC
#+RESULTS:
#+begin_example
(setf find-service) NEW-VALUE NAME &KEY IF-DOES-NOT-EXIST
Set the service designated by the `service-designator' NAME to
NEW-VALUE. When non-nil, NEW-VALUE has to implement the service
protocol.
If NAME already designates a service, the existing service object
is replaced with NEW-VALUE.
If NEW-VALUE is nil, an existing service designated by NAME is
removed.
IF-DOES-NOT-EXIST is accepted for parity with `find-service' and
usually ignored. However, when NEW-VALUE is nil, IF-DOES-NOT-EXIST
controls whether an error should be signaled in case the
to-be-removed service does not exist.
#+end_example
** Provider Protocol
The following generic functions operate on provider objects:
#+BEGIN_SRC lisp :results value :exports results :session "doc"
(doc 'service-provider:provider-name 'function)
#+END_SRC
#+RESULTS:
: provider-name PROVIDER
:
: Return the symbol which is the name of PROVIDER.
The following generic functions query and manipulate the providers
of a service:
#+BEGIN_SRC lisp :results value :exports results :session "doc"
(doc 'service-provider:find-provider 'function)
#+END_SRC
#+RESULTS:
#+begin_example
find-provider SERVICE PROVIDER &KEY IF-DOES-NOT-EXIST
Find and return the provider designated by the
`provider-designator' PROVIDER in the service designated by the
`service-designator' SERVICE.
IF-DOES-NOT-EXIST controls the behavior in case SERVICE or
PROVIDER cannot be found:
The values #'error and 'error cause a `missing-service-error' to
be signaled if SERVICE cannot be found and a
`missing-provider-error' to be signaled if PROVIDER cannot be
found.
The values #'warn and 'warn cause a `missing-service-warning' to
be signaled if SERVICE cannot be found and a
`missing-provider-warning' to be signaled if PROVIDER cannot be
found. In both cases, nil is returned.
The value nil causes nil to be returned without any conditions
being signaled.
`retry' and `use-value' restarts are established around error
signaling (if IF-DOES-NOT-EXIST mandates that).
#+end_example
#+BEGIN_SRC lisp :results value :exports results :session "doc"
(doc '(setf service-provider:find-provider) 'function)
#+END_SRC
#+RESULTS:
#+begin_example
(setf find-provider) NEW-VALUE SERVICE PROVIDER &KEY IF-DOES-NOT-EXIST
Set the provider designated by the `provider-designator' PROVIDER
in the service designated by the `service-designator' SERVICE to
NEW-VALUE. When non-nil, NEW-VALUE has to implement the provider
protocol.
If SERVICE and PROVIDER already designate a provider, the existing
provider object is replaced with NEW-VALUE.
If NEW-VALUE is nil, an existing provider designated by SERVICE
and PROVIDER is removed.
IF-DOES-NOT-EXIST is accepted for parity with `find-provider' and
usually ignored. However, when NEW-VALUE is nil, IF-DOES-NOT-EXIST
controls whether an error should be signaled in case the
to-be-removed provider does not exist.
#+end_example
#+BEGIN_SRC lisp :results value :exports results :session "doc"
(doc 'service-provider:update-provider 'function)
#+END_SRC
#+RESULTS:
: update-provider SERVICE NAME PROVIDER
:
: Update the provider designated by NAME in SERVICE with the new
: value PROVIDER.
#+BEGIN_SRC lisp :results value :exports results :session "doc"
(doc 'service-provider:add-provider 'function)
#+END_SRC
#+RESULTS:
: add-provider SERVICE NAME PROVIDER
:
: Add PROVIDER to SERVICE as the provider designated by NAME.
#+BEGIN_SRC lisp :results value :exports results :session "doc"
(doc 'service-provider:remove-provider 'function)
#+END_SRC
#+RESULTS:
: remove-provider SERVICE NAME PROVIDER
:
: Remove PROVIDER from SERVICE as the provider designated by NAME.
#+BEGIN_SRC lisp :results value :exports results :session "doc"
(doc 'service-provider:make-provider 'function)
#+END_SRC
#+RESULTS:
: make-provider SERVICE PROVIDER &REST ARGS
:
: Make and return an instance of the provider designated by the
: `provider-designator' PROVIDER of the service designated by the
: `service-designator' SERVICE.
** Convenience Layer
The following convenience functions and macros are provided for
registering services:
#+BEGIN_SRC lisp :results value :exports results :session "doc"
(doc 'service-provider:register-service 'function)
#+END_SRC
#+RESULTS:
#+begin_example
register-service NAME SERVICE-CLASS &REST INITARGS
Register a service named NAME according to SERVICE-CLASS and INITARGS.
If NAME does not name an existing service, an instance of
SERVICE-CLASS is made with INITARGS and registered.
If NAME names an existing service, the service is updated via
re-initialization, potentially changing its class to SERVICE-CLASS.
The new or updated service instance is returned.
#+end_example
#+BEGIN_SRC lisp :results value :exports results :session "doc"
(doc 'service-provider:define-service 'function)
#+END_SRC
#+RESULTS:
#+begin_example
define-service NAME &BODY OPTIONS
Define a service named NAME with additional aspects specified in
OPTIONS.
The following OPTIONS are accepted:
(:service-class CLASS-NAME)
Name of the class of the to-be-defined service. Defaults to
`standard-service'.
(:documentation STRING)
If NAME already designates a service, the existing service object
is destructively modified according to OPTIONS.
The service definition is performed at compile, load and execute
time to ensure availability in subsequent provider definitions
and/or compilation of e.g. `find-service' calls.
#+end_example
The following convenience functions are provided for registering
providers:
#+BEGIN_SRC lisp :results value :exports results :session "doc"
(doc 'service-provider:register-provider 'function)
#+END_SRC
#+RESULTS:
#+begin_example
register-provider SERVICE-NAME PROVIDER-NAME PROVIDER-CLASS &REST INITARGS
Register a provider of SERVICE-NAME according to PROVIDER-NAME,
PROVIDER-CLASS and INITARGS.
If PROVIDER-NAME does not name an existing provider of the service
designated by SERVICE-NAME, an instance of PROVIDER-CLASS is made
with INITARGS and registered.
If PROVIDER-NAME names an existing provider of the service
designated by SERVICE-NAME, the provider is updated via
re-initialization, potentially changing its class to
PROVIDER-CLASS.
The new or updated provider instance is returned.
#+end_example
#+BEGIN_SRC lisp :results value :exports results :session "doc"
(doc 'service-provider:register-provider/class 'function)
#+END_SRC
#+RESULTS:
#+begin_example
register-provider/class SERVICE-NAME PROVIDER-NAME &REST ARGS &KEY
(PROVIDER-CLASS 'CLASS-PROVIDER) (CLASS PROVIDER-NAME)
&ALLOW-OTHER-KEYS
Register CLASS as the provider named PROVIDER-NAME of the service
designated by SERVICE-NAME.
PROVIDER-CLASS can be used to select the class of which the created
provider should be an instance.
The `cl:documentation' of CLASS is used as the documentation of the
provider.
#+end_example
#+BEGIN_SRC lisp :results value :exports results :session "doc"
(doc 'service-provider:register-provider/function 'function)
#+END_SRC
#+RESULTS:
#+begin_example
register-provider/function SERVICE-NAME PROVIDER-NAME &REST ARGS &KEY
(PROVIDER-CLASS 'FUNCTION-PROVIDER) #'PROVIDER-NAME
&ALLOW-OTHER-KEYS
Register FUNCTION as the provider named PROVIDER-NAME of the
service designated by SERVICE-NAME.
PROVIDER-CLASS can be used to select the class of which the created
provider should be an instance.
The `cl:documentation' of FUNCTION is used as the documentation of
the provider.
#+end_example
* Related Work
** Java Service Provider Interface
See [[http://docs.oracle.com/javase/6/docs/api/java/util/ServiceLoader.html][documentation of the ServiceLoader class]] for details.
Differences:
* =architecture.service-providers= does not tie services to classes
(or interfaces); services and providers are identified by
symbols (or lists of symbols).
* Introspection is modeled after CLOS introspection, e.g.
=cl:find-class=.
* Documentation is modeled after and integrates =cl:defclass= and
=cl:documentation=.
* Redefinitions and class-changes of services and service providers
are supported.
* Support for compile-time error-detection and optimizations can be
added.
Next: Modules, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
| • The architecture.service-provider system |
Jan Moringen <jmoringe@techfak.uni-bielefeld.de>
Jan Moringen <jmoringe@techfak.uni-bielefeld.de>
LLGPLv3
Provides a framework for registering and finding services and providers of these.
0.6.0
src (module)
Modules are listed depth-first from the system components tree.
| • The architecture.service-provider/src module |
architecture.service-provider (system)
src/
Files are sorted by type and then listed depth-first from the systems components trees.
| • Lisp files |
Next: The architecture․service-provider/src/package․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
architecture.service-provider.asd
architecture.service-provider (system)
Next: The architecture․service-provider/src/types․lisp file, Previous: The architecture․service-provider․asd file, Up: Lisp files [Contents][Index]
src (module)
src/package.lisp
Next: The architecture․service-provider/src/variables․lisp file, Previous: The architecture․service-provider/src/package․lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
src (module)
src/types.lisp
Next: The architecture․service-provider/src/conditions․lisp file, Previous: The architecture․service-provider/src/types․lisp file, Up: Lisp files [Contents][Index]
types.lisp (file)
src (module)
src/variables.lisp
*services* (special variable)
Next: The architecture․service-provider/src/protocol․lisp file, Previous: The architecture․service-provider/src/variables․lisp file, Up: Lisp files [Contents][Index]
variables.lisp (file)
src (module)
src/conditions.lisp
Next: The architecture․service-provider/src/mixins․lisp file, Previous: The architecture․service-provider/src/conditions․lisp file, Up: Lisp files [Contents][Index]
conditions.lisp (file)
src (module)
src/protocol.lisp
Next: The architecture․service-provider/src/service․lisp file, Previous: The architecture․service-provider/src/protocol․lisp file, Up: Lisp files [Contents][Index]
protocol.lisp (file)
src (module)
src/mixins.lisp
Next: The architecture․service-provider/src/provider․lisp file, Previous: The architecture․service-provider/src/mixins․lisp file, Up: Lisp files [Contents][Index]
mixins.lisp (file)
src (module)
src/service.lisp
Next: The architecture․service-provider/src/macros․lisp file, Previous: The architecture․service-provider/src/service․lisp file, Up: Lisp files [Contents][Index]
service.lisp (file)
src (module)
src/provider.lisp
Next: The architecture․service-provider/src/compilation․lisp file, Previous: The architecture․service-provider/src/provider․lisp file, Up: Lisp files [Contents][Index]
provider.lisp (file)
src (module)
src/macros.lisp
define-register-function (macro)
Previous: The architecture․service-provider/src/macros․lisp file, Up: Lisp files [Contents][Index]
macros.lisp (file)
src (module)
src/compilation.lisp
check-service-and-provider (function)
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
| • The service-provider package |
This package contains functions and classes for defining, using
and introspecting services and providers thereof.
For services, the most important functions and macros are
‘find-service’ and ‘define-service’.
For providers, the most important functions and macros are ‘find-provider’, ‘make-provider’, ‘register-provider/class’ and ‘register-provider/funtion’.
package.lisp (file)
Definitions are sorted by export status, category, package, and then by lexicographic order.
| • Exported definitions | ||
| • Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
| • Exported macros | ||
| • Exported compiler macros | ||
| • Exported functions | ||
| • Exported generic functions | ||
| • Exported conditions | ||
| • Exported classes | ||
| • Exported types |
Next: Exported compiler macros, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
Define a service named NAME with additional aspects specified in
OPTIONS.
The following OPTIONS are accepted:
(:service-class CLASS-NAME)
Name of the class of the to-be-defined service. Defaults to
‘standard-service’.
(:documentation STRING)
If NAME already designates a service, the existing service object
is destructively modified according to OPTIONS.
The service definition is performed at compile, load and execute time to ensure availability in subsequent provider definitions and/or compilation of e.g. ‘find-service’ calls.
macros.lisp (file)
Next: Exported functions, Previous: Exported macros, Up: Exported definitions [Contents][Index]
compilation.lisp (file)
compilation.lisp (file)
compilation.lisp (file)
compilation.lisp (file)
compilation.lisp (file)
compilation.lisp (file)
compilation.lisp (file)
compilation.lisp (file)
Next: Exported generic functions, Previous: Exported compiler macros, Up: Exported definitions [Contents][Index]
Register a provider of SERVICE-NAME according to PROVIDER-NAME,
PROVIDER-CLASS and INITARGS.
If PROVIDER-NAME does not name an existing provider of the service
designated by SERVICE-NAME, an instance of PROVIDER-CLASS is made
with INITARGS and registered.
If PROVIDER-NAME names an existing provider of the service
designated by SERVICE-NAME, the provider is updated via
re-initialization, potentially changing its class to
PROVIDER-CLASS.
The new or updated provider instance is returned.
macros.lisp (file)
Register CLASS as the provider named PROVIDER-NAME of the service
designated by SERVICE-NAME.
PROVIDER-CLASS can be used to select the class of which the created
provider should be an instance.
The ‘cl:documentation’ of CLASS is used as the documentation of the provider.
macros.lisp (file)
Register FUNCTION as the provider named PROVIDER-NAME of the
service designated by SERVICE-NAME.
PROVIDER-CLASS can be used to select the class of which the created
provider should be an instance.
The ‘cl:documentation’ of FUNCTION is used as the documentation of the provider.
macros.lisp (file)
Register a service named NAME according to SERVICE-CLASS and INITARGS.
If NAME does not name an existing service, an instance of
SERVICE-CLASS is made with INITARGS and registered.
If NAME names an existing service, the service is updated via re-initialization, potentially changing its class to SERVICE-CLASS.
The new or updated service instance is returned.
macros.lisp (file)
Next: Exported conditions, Previous: Exported functions, Up: Exported definitions [Contents][Index]
Add PROVIDER to SERVICE as the provider designated by NAME.
protocol.lisp (file)
mixins.lisp (file)
Find and return the provider designated by the
‘provider-designator’ PROVIDER in the service designated by the
‘service-designator’ SERVICE.
IF-DOES-NOT-EXIST controls the behavior in case SERVICE or
PROVIDER cannot be found:
The values #’error and ’error cause a ‘missing-service-error’ to
be signaled if SERVICE cannot be found and a
‘missing-provider-error’ to be signaled if PROVIDER cannot be
found.
The values #’warn and ’warn cause a ‘missing-service-warning’ to
be signaled if SERVICE cannot be found and a
‘missing-provider-warning’ to be signaled if PROVIDER cannot be
found. In both cases, nil is returned.
The value nil causes nil to be returned without any conditions
being signaled.
‘retry’ and ‘use-value’ restarts are established around error signaling (if IF-DOES-NOT-EXIST mandates that).
protocol.lisp (file)
(setf find-provider) (generic function)
mixins.lisp (file)
mixins.lisp (file)
Set the provider designated by the ‘provider-designator’ PROVIDER
in the service designated by the ‘service-designator’ SERVICE to
NEW-VALUE. When non-nil, NEW-VALUE has to implement the provider
protocol.
If SERVICE and PROVIDER already designate a provider, the existing
provider object is replaced with NEW-VALUE.
If NEW-VALUE is nil, an existing provider designated by SERVICE
and PROVIDER is removed.
IF-DOES-NOT-EXIST is accepted for parity with ‘find-provider’ and usually ignored. However, when NEW-VALUE is nil, IF-DOES-NOT-EXIST controls whether an error should be signaled in case the to-be-removed provider does not exist.
protocol.lisp (file)
find-provider (generic function)
mixins.lisp (file)
mixins.lisp (file)
Find and return the service designated by the ‘service-designator’
NAME.
IF-DOES-NOT-EXIST controls the behavior in case the designated
service cannot be found:
The values #’error and ’error cause a ‘missing-service-error’ to
be signaled.
The values #’warn and ’warn cause a ‘missing-service-warning’ to
be signaled and nil to be returned.
The value nil causes nil to be returned without any conditions
being signaled.
‘retry’ and ‘use-value’ restarts are established around error signaling (if IF-DOES-NOT-EXIST mandates that).
protocol.lisp (file)
(setf find-service) (generic function)
Set the service designated by the ‘service-designator’ NAME to
NEW-VALUE. When non-nil, NEW-VALUE has to implement the service
protocol.
If NAME already designates a service, the existing service object
is replaced with NEW-VALUE.
If NEW-VALUE is nil, an existing service designated by NAME is
removed.
IF-DOES-NOT-EXIST is accepted for parity with ‘find-service’ and usually ignored. However, when NEW-VALUE is nil, IF-DOES-NOT-EXIST controls whether an error should be signaled in case the to-be-removed service does not exist.
protocol.lisp (file)
find-service (generic function)
Make and return an instance of the provider designated by the ‘provider-designator’ PROVIDER of the service designated by the ‘service-designator’ SERVICE.
protocol.lisp (file)
provider.lisp (file)
provider.lisp (file)
conditions.lisp (file)
conditions.lisp (file)
conditions.lisp (file)
Stores the class providing the service.
provider.lisp (file)
Stores the function providing the service.
provider.lisp (file)
Return the symbol which is the name of PROVIDER.
protocol.lisp (file)
automatically generated reader method
provider.lisp (file)
automatically generated reader method
provider.lisp (file)
Remove PROVIDER from SERVICE as the provider designated by NAME.
protocol.lisp (file)
mixins.lisp (file)
Return the symbol which is the name of SERVICE.
protocol.lisp (file)
automatically generated reader method
service.lisp (file)
Return a sequence of the providers of SERVICE.
protocol.lisp (file)
mixins.lisp (file)
Return the providers of SERVICE as an alist in which CARs are provider names and CDRs are the corresponding provider objects.
protocol.lisp (file)
mixins.lisp (file)
Return the providers of SERVICE as a plist in which keys are provider names and values are the corresponding provider objects.
protocol.lisp (file)
mixins.lisp (file)
Update the provider designated by NAME in SERVICE with the new value PROVIDER.
protocol.lisp (file)
mixins.lisp (file)
Next: Exported classes, Previous: Exported generic functions, Up: Exported definitions [Contents][Index]
This error is signaled when a provider of a certain service is specified as a designator but cannot be found.
conditions.lisp (file)
This warning is signaled when a provider of a certain service is specified as a designator but cannot be found.
conditions.lisp (file)
Subclasses of this are signaled when services specified by designators cannot be found.
conditions.lisp (file)
This warning is signaled when a service specified by a designator cannot be found.
conditions.lisp (file)
Superclass of all conditions signaled by the service-provider system.
conditions.lisp (file)
condition (condition)
Next: Exported types, Previous: Exported conditions, Up: Exported definitions [Contents][Index]
Instances of this class provide a particular service by instantiating a given class.
provider.lisp (file)
provider-name (generic function)
Stores the class providing the service.
class
provider-class (generic function)
| Initarg | Value |
|---|---|
| :class | (more-conditions:missing-required-initarg (quote service-provider:class-provider) :class) |
Instances of this class provide a particular service by calling a given function and returning the result.
provider.lisp (file)
provider-name (generic function)
Stores the function providing the service.
(or symbol function)
provider-function (generic function)
| Initarg | Value |
|---|---|
| :function | (more-conditions:missing-required-initarg (quote service-provider:function-provider) :function) |
This class provides a basic implementation of the service protocol. It can be used as a superclass for specialized service classes.
service.lisp (file)
service-name (generic function)
Previous: Exported classes, Up: Exported definitions [Contents][Index]
A symbol designating a service provider or a service provider.
types.lisp (file)
A symbol designating a service or a service.
types.lisp (file)
Previous: Exported definitions, Up: Definitions [Contents][Index]
| • Internal special variables | ||
| • Internal macros | ||
| • Internal functions | ||
| • Internal generic functions | ||
| • Internal conditions | ||
| • Internal classes | ||
| • Internal types |
Next: Internal macros, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
Stores a mapping of service names to service objects.
variables.lisp (file)
Next: Internal functions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
Define a function named NAME with a lambda-list of the form
(SERVICE-NAME PROVIDER-NAME . KEYWORD-PARAMETERS)
which registers service providers for the given service + provider combinations. ARGS has to be a list of elements the form
(NAME DEFAULT)
. As part of KEYWORD-PARAMETERS, the defined function accepts
a :provider-class keyword parameter which defaults to
DEFAULT-PROVIDER-CLASS. When instantiated, the provider class
will receive as initargs REQUIRED-INITARGS, .
If supplied, DOCUMENTATION will be used as the documentation string of the defined function.
macros.lisp (file)
Next: Internal generic functions, Previous: Internal macros, Up: Internal definitions [Contents][Index]
mixins.lisp (file)
provider.lisp (file)
mixins.lisp (file)
compilation.lisp (file)
Next: Internal conditions, Previous: Internal functions, Up: Internal definitions [Contents][Index]
Return a form which makes and returns an instance of the provider designated by the ‘provider-designator’ PROVIDER of the service designated by the ‘service-designator’ SERVICE for ARGS and ENVIRONMENT.
protocol.lisp (file)
provider.lisp (file)
provider.lisp (file)
Associate provider names to provider instances.
mixins.lisp (file)
Stores nil or a documentation string.
mixins.lisp (file)
Next: Internal classes, Previous: Internal generic functions, Up: Internal definitions [Contents][Index]
Subclasses of this are signaled when providers specified by designators cannot be found within gives services.
conditions.lisp (file)
service-provider-condition (condition)
Stores the service in which the specified provider could not be found.
:service
missing-provider-service (generic function)
The designator for which no provider could be found.
:designator
missing-provider-designator (generic function)
| Initarg | Value |
|---|---|
| :designator | (more-conditions:missing-required-initarg (quote service-provider::missing-provider-condition) :designator) |
| :service | (more-conditions:missing-required-initarg (quote service-provider::missing-provider-condition) :service) |
Subclasses of this are signaled when services specified by designators cannot be found.
conditions.lisp (file)
service-provider-condition (condition)
missing-service-designator (method)
The designator for which no class could be found.
:designator
missing-service-designator (generic function)
| Initarg | Value |
|---|---|
| :designator | (more-conditions:missing-required-initarg (quote service-provider::missing-service-condition) :designator) |
Next: Internal types, Previous: Internal conditions, Up: Internal definitions [Contents][Index]
This class is intended to be mixed into service or provider classes which support associated documentation strings.
mixins.lisp (file)
standard-object (class)
standard-service (class)
Stores nil or a documentation string.
(or null string)
:documentation
service-documentation (generic function)
(setf service-documentation) (generic function)
This class is intended to be mixed into service or provider classes which have an associated name.
mixins.lisp (file)
standard-object (class)
Stores the name of the service or provider.
service-provider:provider-designator
:name
| Initarg | Value |
|---|---|
| :name | (more-conditions:missing-required-initarg (quote service-provider::name-mixin) :name) |
This class is intended to be mixed service classes which have to store a list of providers.
mixins.lisp (file)
standard-object (class)
standard-service (class)
Associate provider names to provider instances.
hash-table
(make-hash-table :test (function equal))
service-%providers (generic function)
Previous: Internal classes, Up: Internal definitions [Contents][Index]
types.lisp (file)
types.lisp (file)
Previous: Definitions, Up: Top [Contents][Index]
| • Concept index | ||
| • Function index | ||
| • Variable index | ||
| • Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
| Jump to: | A F L M |
|---|
| Jump to: | A F L M |
|---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
| Jump to: | %
(
A C D F G M P R S U |
|---|
| Jump to: | %
(
A C D F G M P R S U |
|---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
| Jump to: | *
C D F N P S |
|---|
| Jump to: | *
C D F N P S |
|---|
Previous: Variable index, Up: Indexes [Contents][Index]
| Jump to: | A C D F M N P S T |
|---|
| Jump to: | A C D F M N P S T |
|---|