finagle-clojure.service
Functions for creating instances of com.twitter.finagle.Service.
Service is the main abstraction for both clients & servers.
It is where business logic is implemented.
Services can be created by using mk* & mk,
or by proxying com.twitter.finagle.Service.
Service Services are often implemented with protocol specific helpers (see [[finagle-clojure.thrift/service]]). Client Services are generated by protocol specific helpers (see [[finagle-clojure.thrift/client]]).
If creating an instance of Service with proxy at least the apply method needs to be implemented. Default implementations are provided for all other methods.
Instance methods of Service that can be overridden:
- (apply [req]) ; => Future[response]
- (close [time]) ; => Future[Unit]
- (isAvailable []) ; => boolean
- (map [fn1]) ; => Service[new-response-type]
Functions for creating instances of com.twitter.finagle.Service. Service is the main abstraction for both clients & servers. It is where business logic is implemented. Services can be created by using [[mk*]] & [[mk]], or by proxying com.twitter.finagle.Service. Service Services are often implemented with protocol specific helpers (see [[finagle-clojure.thrift/service]]). Client Services are generated by protocol specific helpers (see [[finagle-clojure.thrift/client]]). If creating an instance of Service with proxy at least the apply method needs to be implemented. Default implementations are provided for all other methods. Instance methods of `Service` that can be overridden: * (apply [req]) ; => Future[response] * (close [time]) ; => Future[Unit] * (isAvailable []) ; => boolean * (map [fn1]) ; => Service[new-response-type]
applyclj
(apply svc request)Sugar for calling Service#apply.
Evaluates a request using Service svc and returns the value calculated.
Arguments:
svc: a Service.request: the input tosvc.
Returns:
the value of svc#apply.
Sugar for calling `Service#apply`. Evaluates a request using Service `svc` and returns the value calculated. *Arguments*: * `svc`: a Service. * `request`: the input to `svc`. *Returns*: the value of `svc#apply`.
available?clj
(available? svc)Is Service svc able to respond to requests?
Arguments:
svc: a Service.
Returns:
true if the service is available, false otherwise.
Is Service `svc` able to respond to requests? *Arguments*: * `svc`: a Service. *Returns*: `true` if the service is available, `false` otherwise.
close!clj
(close! svc deadline-time)Mark Service svc as no longer in use. No further requests should be sent.
Arguments:
svc: a Service.deadline-time: a com.twitter.util.Time instance describing how long to wait for the close to complete.
Returns:
A Future that will be complete when svc has closed.
Mark Service `svc` as no longer in use. No further requests should be sent. *Arguments*: * `svc`: a Service. * `deadline-time`: a com.twitter.util.Time instance describing how long to wait for the close to complete. *Returns*: A Future that will be complete when `svc` has closed. See [[finagle-clojure.duration/->Time]]
mkcljmacro
(mk arg-binding & body)Sugar for creating a scala.Function and calling mk*.
Returns a new Service with the apply method will be implemented with body.
Arguments:
arg-binding: is a vector with 1 element, the name to bind the value of the argument toapply.body: the implementation ofService#apply
Returns:
a new Service.
See: mk*
Sugar for creating a scala.Function and calling `mk*`. Returns a new Service with the `apply` method will be implemented with `body`. *Arguments*: * `arg-binding`: is a vector with 1 element, the name to bind the value of the argument to `apply`. * `body`: the implementation of `Service#apply` *Returns*: a new Service. See: [[mk*]]
mk*clj
(mk* f)Create a new Service.
The apply method will be implemented with fn1
Arguments:
f: a scala.Function1 or Clojure IFn that will be used to implementapply.
Returns:
a new Service.
See: mk
Create a new Service. The `apply` method will be implemented with `fn1` *Arguments*: * `f`: a scala.Function1 or Clojure IFn that will be used to implement `apply`. *Returns*: a new Service. See: [[mk]]
rescueclj
(rescue svc)Returns a service wrapping svc that will lift uncaught exceptions thrown in apply to a Future[Exception].
Arguments:
svc: a Service.
Returns:
a new Service.
Returns a service wrapping `svc` that will lift uncaught exceptions thrown in `apply` to a Future[Exception]. *Arguments*: * `svc`: a Service. *Returns*: a new Service.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close