Trait/Object

agora.api.exchange

Exchange

Related Docs: object Exchange | package exchange

Permalink

trait Exchange extends AnyRef

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

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Exchange
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

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

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

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

    Permalink
    Definition Classes
    Any
  5. final def cancelJobs(job: JobId, theRest: JobId*): Future[CancelJobsResponse]

    Permalink
  6. def cancelJobs(request: CancelJobs): Future[CancelJobsResponse]

    Permalink

    Cancels the submitted jobs, removing them from the exchange

    Cancels the submitted jobs, removing them from the exchange

    request

    the request containing the jobs to cancel

    returns

    a response containing a map between the input job Ids and a flag depicting if they were successfully cancelled

  7. final def cancelSubscriptions(id: worker.SubscriptionKey, theRest: worker.SubscriptionKey*): Future[CancelSubscriptionsResponse]

    Permalink
  8. def cancelSubscriptions(request: CancelSubscriptions): Future[CancelSubscriptionsResponse]

    Permalink
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  12. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  14. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. def onClientRequest(request: ClientRequest): Future[ClientResponse]

    Permalink
  20. def onSubscriptionRequest(req: SubscriptionRequest): Future[SubscriptionResponse]

    Permalink
  21. def queueState(request: QueueState = QueueState()): Future[QueueStateResponse]

    Permalink

    Queue the state of the exchange

    Queue the state of the exchange

    returns

    the current queue state

  22. def submit(req: SubmitJob): Future[ClientResponse]

    Permalink

    Submit a job to the exchange and trigger a match for work.

    Submit a job to the exchange and trigger a match for work.

    If 'awaitMatch' is specified on the SubmitJob then the response will be a BlockingSubmitJobResponse. Otherwise it will just be sent to the exchange an immediately return a SubmitJobResponse.

    If the submitted job already contains a jobId, then that id will be used and any existing submission with the same Id will be replaced.

    req

    the job request

    returns

    either BlockingSubmitJobResponse or a SubmitJobResponse

  23. def subscribe(request: WorkSubscription): Future[WorkSubscriptionAck]

    Permalink

    Creates or updates a WorkSubscription, whose returned WorkSubscriptionAck key can be used to pull work items from the exchange.

    Creates or updates a WorkSubscription, whose returned WorkSubscriptionAck key can be used to pull work items from the exchange.

    If the request specifies a subscription key then any existing subscription with the given id will be updated by having its work details combined w/ the existing subscription

    If no subscription key is supplied, then a new one will be generated and provided on the ack.

    request

    the work subscription

    returns

    an ack containing the key needed to request work items

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

    Permalink
    Definition Classes
    AnyRef
  25. def take(id: worker.SubscriptionKey, itemsRequested: Int): Future[RequestWorkAck]

    Permalink

    convenience method for pulling work items

  26. def take(request: RequestWork): Future[RequestWorkAck]

    Permalink

    request

    the number of work items to request

    returns

    an ack which contains the current known total items requested

  27. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  28. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped