Liking cljdoc? Tell your friends :D
Clojure only.

org.rssys.context.core

*components-path-vec*clj

build-contextclj

(build-context component-list)

build system context using given component-list.

Params:

  • component-list - vector of ::component Returns:
  • atom - as system context if success.
  • `exception - if component-list is invalid or other errors.
# build system context using given component-list.
Params:
 * `component-list` - vector of ::component
Returns:
 * `atom`     - as system context if success.
 * `exception - if component-list is invalid or other errors.
raw docstring

create!clj

(create! *ctx new-component)

create new component in the system context.

Returns:

  • r/success-types - if success.
  • r/error-types - if failure.
# create new component in the system context.
Returns:
 * `r/success-types` - if success.
 * `r/error-types`   - if failure.
raw docstring

delete!clj

(delete! *ctx id-kwd)

delete component from system context.

Returns:

  • r/success-types - if success.
  • r/error-types - if failure.
# delete component from system context.
Returns:
 * `r/success-types` - if success.
 * `r/error-types`   - if failure.
raw docstring

get-componentclj

(get-component *ctx id-kwd)

return component state from system context using its id

# return component state from system context using its id
raw docstring

get-component-valueclj

(get-component-value ctx id-kwd)

return component value from system context value using its id

# return component value from system context value using its id
raw docstring

list-all-idsclj

(list-all-ids *ctx)

get list of ids for all registered components.

Returns:

  • vector of keywords.
# get list of ids for all registered components.
Returns:
 * vector of keywords.
raw docstring

set-config!clj

(set-config! *ctx id-kwd new-config)

set new config for component.

Returns:

  • r/success-types - if success.
  • r/error-types - if failure.
# set new config for component.
Returns:
 * `r/success-types` - if success.
 * `r/error-types`   - if failure.
raw docstring

start!clj

(start! *ctx id-kwd)
(start! *ctx id-kwd start-fn stop-fn)

start component using given id and (optionally) start/stop functions.

Returns:

  • r/success-types - if success.
  • r/error-types - if failure.
# start component using given id and (optionally) start/stop functions.
Returns:
 * `r/success-types` - if success.
 * `r/error-types`   - if failure.
raw docstring

start-allclj

(start-all *ctx)

start all registered components, which are not started yet.

Returns:

  • r/success-types - if success.
  • r/error-types - if failure.
# start all registered components, which are not started yet.
Returns:
 * `r/success-types` - if success.
 * `r/error-types`   - if failure.
raw docstring

start-someclj

(start-some *ctx component-list)

start some of registered components, which are not started yet.

Params:

  • component-list - vector of keywords with component's id. Returns:
  • r/success-types - if success.
  • r/error-types - if failure.
# start some of registered components, which are not started yet.
Params:
 * `component-list` - vector of keywords with component's id.
Returns:
 * `r/success-types` - if success.
 * `r/error-types`   - if failure.
raw docstring

started-idsclj

(started-ids *ctx)

get list of ids for all started components.

Returns:

  • vector of keywords.
# get list of ids for all started components.
Returns:
 * vector of keywords.
raw docstring

started?clj

(started? *ctx id-kwd)

check if component is started.

# check if component is started.
raw docstring

stop!clj

(stop! *ctx id-kwd)

stop component using given id.

Returns:

  • r/success-types - if success.
  • r/error-types - if failure.
# stop  component using given id.
Returns:
 * `r/success-types` - if success.
 * `r/error-types`   - if failure.
raw docstring

stop-allclj

(stop-all *ctx)

stop all registered components, which are not stopped yet.

Returns:

  • r/success-types - if success.
  • r/error-types - if failure.
# stop all registered components, which are not stopped yet.
Returns:
 * `r/success-types` - if success.
 * `r/error-types`   - if failure.
raw docstring

stop-someclj

(stop-some *ctx component-list)

stop some of registered components, which are not stopped yet.

Params:

  • component-list - vector of keywords with component's id. Returns:
  • r/success-types - if success.
  • r/error-types - if failure.
# stop some of registered components, which are not stopped yet.
Params:
 * `component-list` - vector of keywords with component's id.
Returns:
 * `r/success-types` - if success.
 * `r/error-types`   - if failure.
raw docstring

stopped-idsclj

(stopped-ids *ctx)

get list of ids for all stopped components.

Returns:

  • vector of keywords.
# get list of ids for all stopped components.
Returns:
 * vector of keywords.
raw docstring

stopped?clj

update!clj

(update! *ctx new-component-state)

update component's state in the system context.

Returns:

  • r/success-types - if success.
  • r/error-types - if failure.
# update component's state in the system context.
Returns:
 * `r/success-types` - if success.
 * `r/error-types`   - if failure.
raw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
←Move to previous article
→Move to next article
Ctrl+/Jump to the search field
Raise an issueBrowse cljdoc sourceChat on Slack
× close