https://github.com/oaubert/ktbs4js
Modelled traces API for javascript
https://github.com/oaubert/ktbs4js
Last synced: 11 months ago
JSON representation
Modelled traces API for javascript
- Host: GitHub
- URL: https://github.com/oaubert/ktbs4js
- Owner: oaubert
- License: lgpl-3.0
- Created: 2012-02-02T15:41:26.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2015-02-10T13:57:17.000Z (over 11 years ago)
- Last Synced: 2023-03-12T18:55:27.640Z (over 3 years ago)
- Language: JavaScript
- Homepage:
- Size: 890 KB
- Stars: 5
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
KTBS API for JavaScript
=======================
API for storing and accessing modelled traces in JavaScript.
It is based on the abstract client API defined in
https://github.com/ktbs/ktbs/blob/master/doc/source/concepts/abstract_api.rst
It can be used standalone, or use a trace storage system such as
https://github.com/oaubert/nots/ or https://github.com/ktbs/ktbs/
Usage
-----
The main entry point is the {@link tracemanager} singleton. It defines
a {@link TraceManager#init_trace} method that creates a new trace and
keeps a named reference to it.
For writing, obsels can then be added to the new trace through the
{@link Trace#trace} method. See the [example](src/example.js) file for an
example.
For reading, obsels can be accessed through the {@link Trace#obsels}
property.
Notes
-----
The handshake parameter indicates wether a "login" method should be
called on the trace. Calling this method has 2 functions:
- when using POST requests, the synchronisation mechanism is activated
only if this method returns a successful status.
- the default_subject information is passed along in its data. The
trace server is then assumed to memorize this information, and the
lib will not send it in future obsels when using the compact-json
format.