Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the cl-fluidinfo Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 12:17:15 2020 GMT+0.
• Introduction | What cl-fluidinfo is all about | |
• Systems | The systems documentation | |
• Files | The files documentation | |
• Packages | The packages documentation | |
• Definitions | The symbols documentation | |
• Indexes | Concepts, functions, variables and data types |
cl-fluidinfo (cl-fluiddb is the old, original name) is a work-in-progress project of accessing the fluidinfo from Common Lisp. This is by no means done, expect breaking changes in the future.
I do all my work in SBCL, so this is the only implementation currently supported.
You will need
You should use Quicklisp to get these dependencies. No, really. If you aren't using it yet, do yourself a favour and install it before proceeding.
There is also a beginning of some tests written in Lift, so you will need the lift library.
Copyright (c) 2011, Holger Durer All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
• The cl-fluidinfo system | ||
• The cl-fluiddb system |
Next: The cl-fluiddb system, Previous: Systems, Up: Systems [Contents][Index]
codemonkey@betareduction.info
BSD 2-clause license - http://www.opensource.org/licenses/BSD-2-Clause
Library to access the Fluidinfo database / storage and search platform
0.1
cl-fluiddb (system)
cl-fluidinfo.asd (file)
fluidinfo-defpackage.lisp (file)
Previous: The cl-fluidinfo system, Up: Systems [Contents][Index]
codemonkey@betareduction.info
BSD 2-clause license - http://www.opensource.org/licenses/BSD-2-Clause
Library to access the Fluidinfo database / storage and search platform
0.1
cl-fluiddb.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
• The cl-fluidinfo.asd file | ||
• The cl-fluiddb.asd file | ||
• The cl-fluidinfo/fluidinfo-defpackage.lisp file | ||
• The cl-fluiddb/defpackage.lisp file | ||
• The cl-fluiddb/fluiddb.lisp file |
Next: The cl-fluiddb․asd file, Previous: Lisp files, Up: Lisp files [Contents][Index]
cl-fluidinfo.asd
cl-fluidinfo (system)
Next: The cl-fluidinfo/fluidinfo-defpackage․lisp file, Previous: The cl-fluidinfo․asd file, Up: Lisp files [Contents][Index]
cl-fluiddb.asd
cl-fluiddb (system)
*cl-fluiddb-version* (special variable)
Next: The cl-fluiddb/defpackage․lisp file, Previous: The cl-fluiddb․asd file, Up: Lisp files [Contents][Index]
cl-fluidinfo (system)
fluidinfo-defpackage.lisp
Next: The cl-fluiddb/fluiddb․lisp file, Previous: The cl-fluidinfo/fluidinfo-defpackage․lisp file, Up: Lisp files [Contents][Index]
cl-fluiddb (system)
defpackage.lisp
Previous: The cl-fluiddb/defpackage․lisp file, Up: Lisp files [Contents][Index]
defpackage.lisp (file)
cl-fluiddb (system)
fluiddb.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The cl-fluidinfo package | ||
• The cl-fluiddb-asd package | ||
• The cl-fluiddb package |
Next: The cl-fluiddb-asd package, Previous: Packages, Up: Packages [Contents][Index]
fluidinfo-defpackage.lisp (file)
Next: The cl-fluiddb package, Previous: The cl-fluidinfo package, Up: Packages [Contents][Index]
cl-fluiddb.asd
*cl-fluiddb-version* (special variable)
Previous: The cl-fluiddb-asd package, Up: Packages [Contents][Index]
defpackage.lisp (file)
common-lisp
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 special variables | ||
• Exported macros | ||
• Exported functions | ||
• Exported generic functions |
Next: Exported macros, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
Timeout (in seconds) to use for any call to the FluidDB server.
If a timeout happens, a bordeaux-threads:timeout condition will be raised.
A value of nil means not to use any timeout.
fluiddb.lisp (file)
User credentidals to be used for a request.
Should be either nil (anonymous access) or a list of two strings (username password)
fluiddb.lisp (file)
Credentials to be used to authenticate against the proxy configured via *proxy-server*
fluiddb.lisp (file)
Information about the proxy server to use for requests.
Should be either nil (direct access), a string (the server to use),
or a list of two values (server port)
fluiddb.lisp (file)
Flag whether to use HTTPS or just HTTP
fluiddb.lisp (file)
The string to be used as your user agent when making request.
This might allow FluidInfo to better monitor what app is using their service
fluiddb.lisp (file)
Next: Exported functions, Previous: Exported special variables, Up: Exported definitions [Contents][Index]
Perform body with the passed fluiddb credentials in place
fluiddb.lisp (file)
Next: Exported generic functions, Previous: Exported macros, Up: Exported definitions [Contents][Index]
Change the description of the given namespace
fluiddb.lisp (file)
Change the description of the given tag
fluiddb.lisp (file)
Create a new sub-namespace within the passed namespace
fluiddb.lisp (file)
Create a new object (anonymous if no about is specified)
fluiddb.lisp (file)
Create a new tag withing the given namespace
fluiddb.lisp (file)
Delete the given namespace
fluiddb.lisp (file)
Delete the specified tag value on the object with the given about tag
fluiddb.lisp (file)
Delete the specified tag value on the object with the given id
fluiddb.lisp (file)
Perform a query and delete the specified tag values on the matching objects
fluiddb.lisp (file)
Delete the given tag
fluiddb.lisp (file)
Retrieve information about the given namespace
fluiddb.lisp (file)
Retrieve the permission information for the given namespace and action. Action can be one of create, update, delete, list, control.
fluiddb.lisp (file)
Retrieve an object by its id
fluiddb.lisp (file)
Retrieve an object by its about tag
fluiddb.lisp (file)
Retrieve the object’s tag value for the object with the given about tag
fluiddb.lisp (file)
Retrieve the object’s tag value for the object with the given id
fluiddb.lisp (file)
Retrieve the user’s default policy for the given category and action.
Possible values for categorie/actions are:
- namespaces: create, update, delete, and list.
- tags: update and delete.
- tag-values: create, read, and delete.
fluiddb.lisp (file)
Retrieve information about the given tag
fluiddb.lisp (file)
Retrieve the permission information for the given tag and action. Action can be one of update, delete, control.
fluiddb.lisp (file)
Retrieve the permission information for the given tag value and action. Action can be one of create, read, delete, control.
fluiddb.lisp (file)
Retrieve information about the user with the given name
fluiddb.lisp (file)
Check if the object with the given about tag has the specified tag value set. Returns nil or the mime type of the value.
fluiddb.lisp (file)
Check if the object with the given id has the specified tag value set. Returns nil or the mime type of the value.
fluiddb.lisp (file)
Perform a query for all object matching
fluiddb.lisp (file)
Perform a query and retrieve all objects matching plus the specified tag values on them
fluiddb.lisp (file)
Set the permission information for the given namespace and action. Action can be one of create, update, delete, list, control. Policy can be either open or closed.
fluiddb.lisp (file)
Set the specified tag value on the object with the given about tag. Content is either presumed to be pre-formatted (if content-type is given) or will be JSON encoded and passed a fluiddb primitive type.
fluiddb.lisp (file)
Set the specified tag value on the object with the given id.
Content is either presumed to be pre-formatted (if content-type is given)
or will be JSON encoded and passed as a fluiddb primitive type.
fluiddb.lisp (file)
Perform a query and set the specified tag values on the matching objects
fluiddb.lisp (file)
Set the user’s default policy for the given category and action.
Possible values for categorie/actions are:
- namespaces: create, update, delete, and list.
- tags: update and delete.
- tag-values: create, read, and delete.
Policy can be either open or closed.
fluiddb.lisp (file)
Set the permission information for the given tag and action.
Action can be one of update, delete, control.
Policy can be either open or closed.
fluiddb.lisp (file)
Set the permission information for the given tag value and action.
Action can be one of create, read, delete, control.
Policy can be either open or closed.
fluiddb.lisp (file)
Previous: Exported functions, Up: Exported definitions [Contents][Index]
fluiddb.lisp (file)
fluiddb.lisp (file)
fluiddb.lisp (file)
fluiddb.lisp (file)
fluiddb.lisp (file)
Helper function to convert some object into a (url-escaped) string ready to be used as part of the path in the request URL
fluiddb.lisp (file)
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal special variables | ||
• Internal functions | ||
• Internal conditions | ||
• Internal structures |
Next: Internal functions, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
A string denoting the current version of this package. Used for diagnostic output.
cl-fluiddb.asd
A store for any existing connection to the server that can be re-used
fluiddb.lisp (file)
Base URL (without the http:// or https:// protocol bit) for the server to call
fluiddb.lisp (file)
fluiddb.lisp (file)
Next: Internal conditions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
fluiddb.lisp (file)
Lower-level routine to send a request to FluidDB.
Set accept to the content-type you want ("*/*" if you don’t know).
This does not interpret the results and just returns the HTTP response. It may still throw errors on network problems, timeouts etc.
fluiddb.lisp (file)
fluiddb.lisp (file)
fluiddb.lisp (file)
fluiddb.lisp (file)
Return a JSON encoded string representing the passed permission. Policy should be either open or closed.
fluiddb.lisp (file)
Send a request to FluidDB.
Set accept to the content-type you want ("*/*" if you don’t know).
We inspect the return data and convert it to a lisp data structure if it is json
fluiddb.lisp (file)
fluiddb.lisp (file)
Convert a lisp value to something the JSON encode will convert to true or false
fluiddb.lisp (file)
Do sensible conversion to a string
fluiddb.lisp (file)
URL encode a string so it’s safe to include in an URL
fluiddb.lisp (file)
Next: Internal structures, Previous: Internal functions, Up: Internal definitions [Contents][Index]
fluiddb.lisp (file)
error (condition)
:status-code
status-code (generic function)
(setf status-code) (generic function)
:status-message
status-message (generic function)
(setf status-message) (generic function)
:error-class
error-class (generic function)
(setf error-class) (generic function)
:request-id
request-id (generic function)
(setf request-id) (generic function)
:error-body
error-body (generic function)
(setf error-body) (generic function)
Previous: Internal conditions, Up: Internal definitions [Contents][Index]
fluiddb.lisp (file)
structure-object (structure)
encode-json (method)
json-alist-values (function)
(setf json-alist-values) (function)
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: | C F L |
---|
Jump to: | C F L |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
Jump to: | (
C D E F G J M O Q R S T U W |
---|
Jump to: | (
C D E F G J M O Q R S T U W |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Jump to: | *
E R S V |
---|
Jump to: | *
E R S V |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | C J P S |
---|
Jump to: | C J P S |
---|