exchange

Type Members

1. case class BlockingSubmitJobResponse(matchId: MatchId, jobId: JobId, matchedAt: LocalDateTime, workerCoords: List[WorkerRedirectCoords], workers: List[WorkerDetails]) extends ClientResponse with Product with Serializable

   

2. case class CancelJobs(ids: Set[JobId]) extends ClientRequest with Product with Serializable

   

3. case class CancelJobsResponse(canceledJobs: Map[JobId, Boolean]) extends ClientResponse with Product with Serializable

   

4. case class CancelSubscriptions(ids: Set[worker.SubscriptionKey]) extends ClientRequest with Product with Serializable

   

5. case class CancelSubscriptionsResponse(canceledSubscriptions: Map[worker.SubscriptionKey, Boolean]) extends ClientResponse with Product with Serializable

   

6. case class Candidate(subscriptionKey: worker.SubscriptionKey, subscription: WorkSubscription, remaining: Int) extends Product with Serializable

   

7. sealed trait ClientRequest extends AnyRef

   

   A 'client' represents something which submits work to the exchange

8. sealed trait ClientResponse extends AnyRef

   

9. trait Exchange extends AnyRef

   

   An exchange supports both 'client' requests (e.g.

   An exchange supports both 'client' requests (e.g. offering and cancelling work to be done) and work subscriptions

10. class ExchangeInstance extends Exchange with StrictLogging

    

    A default, ephemeral, non-thread-safe implementation of an exchange

11. case class ExchangeState(subscriptionsById: Map[worker.SubscriptionKey, (WorkSubscription, Requested)] = ..., jobsById: Map[JobId, SubmitJob] = Map[JobId, SubmitJob]()) extends StrictLogging with Product with Serializable

    

    An immutable view of the exchange state

12. trait InputDao[T] extends AnyRef

    

13. trait JobPredicate extends AnyRef

    

    Exposes the course-grained signature of pairing up jobs with worker subscriptions.

    Exposes the course-grained signature of pairing up jobs with worker subscriptions.

    In practice there is just one implementation which evaluates the json matchers of the SubmitJob and WorkSubscription, but in theory you could implement any test to pair up jobs with work subscriptions

14. case class MatchNotification(jobId: JobId, job: SubmitJob, chosen: CandidateSelection) extends Product with Serializable

    

15. trait MatchObserver extends OnMatch with StrictLogging

    

    Represents a match 'handler' which delegates out to other observers

16. case class PendingSubscription(key: worker.SubscriptionKey, subscription: WorkSubscription, requested: Int) extends Product with Serializable

    

17. case class QueueState(workerSubscriptionMatcher: JMatcher = JMatcher.matchAll, submitJobMatcher: JMatcher = JMatcher.matchAll, submitJobSubmissionDetailsMatcher: JMatcher = JMatcher.matchAll) extends ClientRequest with Product with Serializable

    

    Queries the exchange for a view of the pending jobs and subscriptions

    Queries the exchange for a view of the pending jobs and subscriptions

    workerSubscriptionMatcher

    the same as what a SubmitJob matcher would be, used to match work subscriptions

    submitJobMatcher

    the same as a subscription matcher would be, used to match submitted job requests

    submitJobSubmissionDetailsMatcher

    also as per a subscription matcher, this time matching the submissionDetails

18. case class QueueStateResponse(jobs: List[SubmitJob], subscriptions: List[PendingSubscription]) extends ClientResponse with Product with Serializable

    

19. case class RequestWork(id: worker.SubscriptionKey, itemsRequested: Int) extends SubscriptionRequest with Product with Serializable

    

20. case class RequestWorkAck(id: worker.SubscriptionKey, previousItemsPending: Int, totalItemsPending: Int) extends SubscriptionResponse with Product with Serializable

    

21. case class SelectIntMax(path: JPath) extends SelectionMode with Product with Serializable

    

22. case class SelectN(n: Int, fanOut: Boolean) extends SelectionMode with Product with Serializable

    

23. case class SelectionAll() extends SelectionMode with Product with Serializable

    

24. case class SelectionFirst() extends SelectionMode with Product with Serializable

    

25. abstract class SelectionMode extends AnyRef

    

    A SelectionMode determines which matched candidate(s) are chosen from an Exchange selection.

    A SelectionMode determines which matched candidate(s) are chosen from an Exchange selection.

    For example, if there is a pool of 10 work subscriptions, and a job is submitted which matches three of them, the SelectionMode determines which of the three are selected.

    Typically just the _best_ one of the list is chosen for some configurable meaning of _best_, though it could select any number of work candidates.

26. case class ServerSideExchange(underlying: Exchange, observer: MatchObserver = MatchObserver()) extends Exchange with Product with Serializable

    

    Adds a special type for local exchanges.

    Adds a special type for local exchanges. also exposing a means to observe jobs

27. case class SubmissionDetails(aboutMe: Json, selection: SelectionMode, awaitMatch: Boolean, workMatcher: JMatcher, orElse: List[JMatcher]) extends JsonAppendable with Product with Serializable

    

    The SubmissionDetails is the ansillary information submitted with a job request.

    The SubmissionDetails is the ansillary information submitted with a job request.

    Where a typical REST endpoint would just take some POSTed json request, the SubmitJob requests wraps that json together will some information intended for the Exchange in order for it to match the job with a worker.

    The SubmissionDetails is that additional information to act as instructions/information specific to the job scheduling/matching. It contains:

    aboutMe

    a hold-all json blob which can include any details a client request wishes to expose to potential workers. It could contain e.g. session information, the submitting or 'run-as' user, etc.

    selection

    an instruction on which/how to select matching work subscriptions as an opportunity to filter on best-fit

    awaitMatch

    if true, the job submission to the exchange should block until one or more matching worker(s) is found

    workMatcher

    the json criteria used to match work subscriptions

    orElse

    should the 'workMatcher' not match _any_ current work subscriptions, the SubmitJob is resubmitted with the 'orElse' criteria

28. case class SubmitJob(submissionDetails: SubmissionDetails, job: Json) extends ClientRequest with Product with Serializable

    

    Represents anything which can be run as a job, together with some submissionDetails which are used to instruct the Exchange.

    Represents anything which can be run as a job, together with some submissionDetails which are used to instruct the Exchange.

    Where a basic REST endpoint would typically be POSTed some json data, a 'SubmitJob' acts as an envelope for that 'job', pairing it with some additional SubmissionDetails.

    The Exchange can then use both the job and submission details to match work with pulling work subscriptions based on the criteria/selection mode/etc specified by the submission details and work subscription.

    job

    represents the job submission. As the job repo is heterogeneous, it could match anything really that's asking for work

29. case class SubmitJobResponse(id: JobId) extends ClientResponse with Product with Serializable

    

30. sealed trait SubscriptionRequest extends AnyRef

    

31. sealed trait SubscriptionResponse extends AnyRef

    

32. case class UpdateSubscription(id: worker.SubscriptionKey, details: WorkerDetails) extends SubscriptionRequest with Product with Serializable

    

33. case class UpdateSubscriptionAck(id: worker.SubscriptionKey, oldDetails: Option[WorkerDetails], newDetails: Option[WorkerDetails]) extends SubscriptionResponse with Product with Serializable

    

34. case class WorkSubscription(details: WorkerDetails, jobMatcher: JMatcher, submissionMatcher: JMatcher, subscriptionReferences: Set[worker.SubscriptionKey]) extends SubscriptionRequest with Product with Serializable

    

    The details contain info about the worker subscribing to work, such as it's location (where work should be sent to), and any arbitrary json data it wants to expose (nr of CPUs, runAs user, available memory, OS, a 'topic', etc)

    The details contain info about the worker subscribing to work, such as it's location (where work should be sent to), and any arbitrary json data it wants to expose (nr of CPUs, runAs user, available memory, OS, a 'topic', etc)

    Once a WorkSubscription is sent

    details

    represents a json blob of data which can be matched by SubmissionDetails match criteria to filter out workers

    jobMatcher

    the criteria used to match submitted job data

    submissionMatcher

    the criteria used to match submitted jobs' submission details

    subscriptionReferences

    If non-empty, changes to the number of work items requested for this subscription will be performed on the referenced subscriptions

35. case class WorkSubscriptionAck(id: worker.SubscriptionKey) extends SubscriptionResponse with Product with Serializable