Liking cljdoc? Tell your friends :D

capn-hook.core

This namespace is the main user-facing API for the library that will send all the webhook messages to the registered listeners. If one is never listening, we'll keep trying to send to it for a very long time.

This namespace is the main user-facing API for the library that will send
all the webhook messages to the registered listeners. If one is never
listening, we'll keep trying to send to it for a very long time.
raw docstring

chillclj

This is the interval time between restarts on the sending of the callbacks to the registered listeners - in msec.

This is the interval time between restarts on the sending of the callbacks
to the registered listeners - in msec.
sourceraw docstring

deregister!clj

(deregister! url)

Function to remove a url from all webhook registrations. This is a simple way to remove a url without having to worry where it might have been registered.

Function to remove a url from *all* webhook registrations. This is a simple
way to remove a url without having to worry where it might have been
registered.
sourceraw docstring

fire!clj

(fire! wh msg)

Function to take a representation of a sequence of urls, and a message to send to all registered targets of that particular webhook. The first arg can be a function that will be expected to return a sequence of urls, or it can be a sequence of urls, or a single url, or a keyword, in which case, we'll look up the registration from the internal list. This will actually just enqueue the complete message onto the durable queue of the correct name, and then let the processing of that queue handle the rest.

Function to take a representation of a sequence of urls, and a message
to send to all registered targets of that particular webhook. The first
arg can be a function that will be expected to return a sequence of urls,
or it can be a sequence of urls, or a single url, or a keyword, in which
case, we'll look up the registration from the internal list. This will
actually just enqueue the complete message onto the durable queue of the
correct name, and then let the processing of that queue handle the rest.
sourceraw docstring

flush!clj

(flush!)

Function to flush the queue of all pending callbacks so that anything that was in the queue is now lost. This is a permanent operation!

Function to flush the queue of *all* pending callbacks so that anything
that was in the queue is now lost. This is a permanent operation!
sourceraw docstring

poolclj

source

register!clj

(register! wh url)

Function to add the url to the set of all targets for the supplied webhook. This will be a set of urls, so there is no chance of duplication within the registration.

Function to add the url to the set of all targets for the supplied webhook.
This will be a set of urls, so there is no chance of duplication within the
registration.
sourceraw docstring

registrationsclj

source

start!clj

(start!)

Function to start a worker thread for sending the callbacks to the registered lsteners, and to continue doing so until the process is stopped or the stop! function is called.

Function to start a worker thread for sending the callbacks to the
registered lsteners, and to continue doing so until the process is
stopped or the `stop!` function is called.
sourceraw docstring

stop!clj

(stop!)

Function to stop sending the callbacks to the recipients. This just shuts down the sending thread and that's it.

Function to stop sending the callbacks to the recipients. This just
shuts down the sending thread and that's it.
sourceraw docstring

targetsclj

(targets hook)

Function to return a sequence of targets for a supplied 'webhook' name. The system is capable of having any number of 'nameed' webhooks - imagine 'create', 'read', 'update', 'delete' for a standard editable service. The return value is a sequence of urls to POST to:

["http://foo.com/hit/me", "http://bar.com/punch"]

.

Function to return a sequence of targets for a supplied 'webhook' name. The
system is capable of having any number of 'nameed' webhooks - imagine 'create',
'read', 'update', 'delete' for a standard editable service. The return value
is a sequence of urls to POST to:

  ["http://foo.com/hit/me", "http://bar.com/punch"]

.
sourceraw docstring

workerclj

source

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close