WorkContext

Instance Constructors

new WorkContext(exchange: Exchange, routes: DynamicWorkerRoutes, subscriptionKey: Option[SubscriptionKey], subscription: WorkSubscription, requestContext: RequestContext, request: T)(implicit arg0: FromRequestUnmarshaller[T])

exchange
the interface to an exchange so it can request more work or even cancel the subscription or return the job
routes
the worker routes containing this handler
subscription
the details of the subscription
requestContext
the http request context which contains the original HttpRequest, etc
request
the unmarshalled handler input

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def asResponse[A](compute: ⇒ A)(implicit arg0: ToResponseMarshaller[A]): Future[HttpResponse]
def become(newHandler: (WorkContext[T]) ⇒ Unit): Boolean

Replace the current handler logic with the new handler
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @throws( ... )
def complete[A](compute: ⇒ A)(implicit arg0: ToResponseMarshaller[A]): WorkContext[T]

Completing the request means sending a response back to the client and requesting another work item.
Completing the request means sending a response back to the client and requesting another work item.
The inner 'complete' thunk is lazy, so another work item will be requested even if the given lazily-evaluated return value throws an exception.
compute
the lazy value to return, and upon the completion of which a new work item will be requested
returns
this context (builder pattern)
def completeReplyOnly[A](compute: ⇒ A)(implicit arg0: ToResponseMarshaller[A]): WorkContext[T]

completes this request, but doesn't request any more work from the exchange
completes this request, but doesn't request any more work from the exchange
compute
the result
returns
this work context
def completeWith[A](respFuture: Future[A], numberToRequest: Int = 1)(implicit arg0: ToResponseMarshaller[A]): WorkContext[T]

By calling 'completeWith', it assures that another work item will be requested when this future completes (whether successfully or not)
By calling 'completeWith', it assures that another work item will be requested when this future completes (whether successfully or not)
A
the response type
respFuture
the response with which will be marshalled back to the client (and upon who's completion a new work item will be requested)
returns
this context (builder pattern)
def completeWithJson[A](value: ⇒ A)(implicit enc: Encoder[A]): WorkContext[T]

complete with the json value
complete with the json value
value
the value to complete
returns
this context (builder pattern)
def completeWithSource(dataSource: Source[ByteString, Any], contentType: ContentType = `application/octet-stream`, numberToRequest: Int = 1): WorkContext[T]

A convenience method to complete (return a result and request a new work item) with a byte source
def details: WorkerDetails

returns
the subscription details
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val exchange: Exchange

the interface to an exchange so it can request more work or even cancel the subscription or return the job
def flatMapMultipart[A](f: PartialFunction[(MultipartInfo, Source[ByteString, Any]), Future[A]])(implicit ev: =:=[T, FormData]): Future[Seq[A]]
def foreachMultipart[A](f: PartialFunction[(MultipartInfo, Source[ByteString, Any]), A])(implicit ev: =:=[T, FormData]): Future[Seq[A]]

returns
a value 'A' for each multipart info/source pair to which this partial function applies
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def map[A](f: (T) ⇒ A)(implicit arg0: FromRequestUnmarshaller[A]): WorkContext[A]
def mapFirstMultipart[A](f: PartialFunction[(MultipartInfo, Source[ByteString, Any]), A])(implicit ev: =:=[T, FormData]): Future[A]
def mapMultipart[A](f: PartialFunction[(MultipartInfo, Source[ByteString, Any]), A])(implicit ev: =:=[T, FormData]): Future[Seq[A]]
val matchDetails: Option[MatchDetails]

The match details associated with this request invocation.
The match details associated with this request invocation. As the endpoint is just a normal endpoint which could be invoked directly w/o having been redirected from an Exchange, it could be empty.
The MatchDetails are provided by values taken from the Http Headers.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
def path: String

returns
the path specified for the handler
def replaceSubscription(newSubscription: WorkSubscription): Future[WorkContext[T]]

Replace the current subscription, effectively cancelling/creating a new subscription.
Replace the current subscription, effectively cancelling/creating a new subscription.
newSubscription
the new subscription
returns
the updated work context w/ the new work subscription

Note
The new subscription will be created, but no initial work items will be requested
def request(n: Int): Option[Future[RequestWorkAck]]

n
the number of work items to request (typically 1, as we take one for each one we compute)
returns
the Ack (if we indeed had a subscription key)
val request: T

the unmarshalled handler input
val requestContext: RequestContext

the http request context which contains the original HttpRequest, etc
def responseFuture: Future[HttpResponse]
val routes: DynamicWorkerRoutes

the worker routes containing this handler
val subscription: WorkSubscription

the details of the subscription
val subscriptionKey: Option[SubscriptionKey]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def updateSubscription(f: (WorkSubscription) ⇒ WorkSubscription): Future[WorkContext[T]]

Convenience function for 'replaceSubscription' which operates on the current subscription
Convenience function for 'replaceSubscription' which operates on the current subscription
f
the update subscription
returns
the updated context with the new subscription
def updateSubscription(update: UpdateSubscription): Future[UpdateSubscriptionAck]

update the subscription which made this request using the given name/data value
update the subscription which made this request using the given name/data value
update
the subscription update
returns
a future of the update
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.

Related Docs: object WorkContext | package worker

case class WorkContext[T](exchange: Exchange, routes: DynamicWorkerRoutes, subscriptionKey: Option[SubscriptionKey], subscription: WorkSubscription, requestContext: RequestContext, request: T)(implicit evidence$1: FromRequestUnmarshaller[T]) extends Product with Serializable

Instance Constructors

new WorkContext(exchange: Exchange, routes: DynamicWorkerRoutes, subscriptionKey: Option[SubscriptionKey], subscription: WorkSubscription, requestContext: RequestContext, request: T)(implicit arg0: FromRequestUnmarshaller[T])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def asResponse[A](compute: ⇒ A)(implicit arg0: ToResponseMarshaller[A]): Future[HttpResponse]

def become(newHandler: (WorkContext[T]) ⇒ Unit): Boolean

def clone(): AnyRef

def complete[A](compute: ⇒ A)(implicit arg0: ToResponseMarshaller[A]): WorkContext[T]

def completeReplyOnly[A](compute: ⇒ A)(implicit arg0: ToResponseMarshaller[A]): WorkContext[T]

def completeWith[A](respFuture: Future[A], numberToRequest: Int = 1)(implicit arg0: ToResponseMarshaller[A]): WorkContext[T]

def completeWithJson[A](value: ⇒ A)(implicit enc: Encoder[A]): WorkContext[T]

def completeWithSource(dataSource: Source[ByteString, Any], contentType: ContentType = `application/octet-stream`, numberToRequest: Int = 1): WorkContext[T]

def details: WorkerDetails

final def eq(arg0: AnyRef): Boolean

val exchange: Exchange

def flatMapMultipart[A](f: PartialFunction[(MultipartInfo, Source[ByteString, Any]), Future[A]])(implicit ev: =:=[T, FormData]): Future[Seq[A]]

def foreachMultipart[A](f: PartialFunction[(MultipartInfo, Source[ByteString, Any]), A])(implicit ev: =:=[T, FormData]): Future[Seq[A]]

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

def map[A](f: (T) ⇒ A)(implicit arg0: FromRequestUnmarshaller[A]): WorkContext[A]

def mapFirstMultipart[A](f: PartialFunction[(MultipartInfo, Source[ByteString, Any]), A])(implicit ev: =:=[T, FormData]): Future[A]

def mapMultipart[A](f: PartialFunction[(MultipartInfo, Source[ByteString, Any]), A])(implicit ev: =:=[T, FormData]): Future[Seq[A]]

val matchDetails: Option[MatchDetails]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def path: String

def replaceSubscription(newSubscription: WorkSubscription): Future[WorkContext[T]]

def request(n: Int): Option[Future[RequestWorkAck]]

val request: T

val requestContext: RequestContext

def responseFuture: Future[HttpResponse]

val routes: DynamicWorkerRoutes

val subscription: WorkSubscription

val subscriptionKey: Option[SubscriptionKey]

final def synchronized[T0](arg0: ⇒ T0): T0

def updateSubscription(f: (WorkSubscription) ⇒ WorkSubscription): Future[WorkContext[T]]

def updateSubscription(update: UpdateSubscription): Future[UpdateSubscriptionAck]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Deprecated Value Members

def finalize(): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped