Class/Object

com.github.cb372.finagle.beanstalk.client

BeanstalkClient

Related Docs: object BeanstalkClient | package client

Permalink

class BeanstalkClient extends AnyRef

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. BeanstalkClient
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BeanstalkClient(service: BeanstalkService, yamlParser: YamlParser = new StoopidYamlParser)

    Permalink

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. def bury(id: Int, priority: Int): Future[Boolean]

    Permalink

    Bury the job with the given ID

    Bury the job with the given ID

    id

    the job's ID

    priority

    the new priority to give the job

    returns

    true if the job was successfully buried

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def delete(id: Int): Future[Boolean]

    Permalink

    Delete the job with the given ID

    Delete the job with the given ID

    id

    the job's ID

    returns

    true if the job was deleted

  8. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

    Permalink
    Definition Classes
    Any
  14. def kick(max: Int): Future[Either[Reply, Int]]

    Permalink

    Kick any buried and/or delayed jobs in the current tube into the ready queue

    Kick any buried and/or delayed jobs in the current tube into the ready queue

    max

    the maximum number of jobs to kick

    returns

    the number of jobs actually kicked, or an error reply

  15. def listTubeUsed(): Future[Either[Reply, String]]

    Permalink

    Get the name of the tube we are currently using

  16. def listTubes(): Future[Either[Reply, Seq[String]]]

    Permalink

    Retrieve a list of all tubes that currently exist.

    Retrieve a list of all tubes that currently exist. Note that tubes are created on-demand and disappear when they are not needed anymore (i.e. when they are empty and no clients are watching them).

  17. def listTubesWatched(): Future[Either[Reply, Seq[String]]]

    Permalink

    Retrieve a list of all tubes that we are watching.

  18. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  21. def pauseTube(tube: String, delay: Int): Future[Either[Reply, Boolean]]

    Permalink

    Pause the given tube for the given number of seconds.

    Pause the given tube for the given number of seconds.

    returns

    true if the tube was paused, false if it was not found, error otherwise

  22. def peek(id: Int): Future[Option[Job[Array[Byte]]]]

    Permalink

    Peek at the given job

    Peek at the given job

    id

    the job ID

    returns

    a job, if it exists

  23. def peekBuried(): Future[Option[Job[Array[Byte]]]]

    Permalink

    Peek at the next job in the list of buried jobs

    Peek at the next job in the list of buried jobs

    returns

    a job, if it exists

  24. def peekDelayed(): Future[Option[Job[Array[Byte]]]]

    Permalink

    Peek at the delayed job with the least remaining delay

    Peek at the delayed job with the least remaining delay

    returns

    a job, if it exists

  25. def peekReady(): Future[Option[Job[Array[Byte]]]]

    Permalink

    Peek at the next ready job

    Peek at the next ready job

    returns

    a job, if it exists

  26. def put(data: Array[Byte], options: PutOpts): Future[Either[Reply, Int]]

    Permalink

    Insert the given bytes as a beanstalkd job

    Insert the given bytes as a beanstalkd job

    data

    the job

    options

    configuration options

    returns

    the job's ID, or an error reply

  27. def put(data: String, options: PutOpts)(implicit charset: String = "UTF-8"): Future[Either[Reply, Int]]

    Permalink

    Insert the given string as a beanstalkd job

    Insert the given string as a beanstalkd job

    data

    the job

    options

    configuration options

    charset

    charset of the string

    returns

    the job's ID

  28. def quit(): Unit

    Permalink

    Retrieve a list of all tubes that we are watching.

  29. def release(id: Int, priority: Int, delay: Int): Future[Boolean]

    Permalink

    Release the job with the given ID

    Release the job with the given ID

    id

    the job's ID

    priority

    the new priority to give the job

    delay

    delay in seconds

    returns

    true if the job was successfully released

  30. def reserve(timeout: Int): Future[Either[Reply, Job[Array[Byte]]]]

    Permalink

    Reserve a job, with a timeout

    Reserve a job, with a timeout

    timeout

    timeout in seconds

    returns

    a job, or an error reply

  31. def reserve(): Future[Either[Reply, Job[Array[Byte]]]]

    Permalink

    Reserve a job, with no timeout

    Reserve a job, with no timeout

    returns

    a job, or an error reply

  32. def stats(): Future[Either[Reply, Map[String, String]]]

    Permalink

    Retrieve stats about the beanstalkd server

    Retrieve stats about the beanstalkd server

    returns

    stats data

  33. def statsJob(id: Int): Future[Either[Reply, Map[String, String]]]

    Permalink

    Retrieve stats about the given job

    Retrieve stats about the given job

    id

    job ID

    returns

    stats data

  34. def statsTube(tube: String): Future[Either[Reply, Map[String, String]]]

    Permalink

    Retrieve stats about the given tube

    Retrieve stats about the given tube

    tube

    tube name

    returns

    stats data

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

    Permalink
    Definition Classes
    AnyRef
  36. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  37. def touch(id: Int): Future[Boolean]

    Permalink

    Touch the job with the given ID, in order to request more time to work

    Touch the job with the given ID, in order to request more time to work

    id

    the job's ID

    returns

    true if the job was successfully found and touched

  38. def use(tube: String): Future[Either[Reply, String]]

    Permalink

    Use the given tube for producing subsequent messages

    Use the given tube for producing subsequent messages

    tube

    the tube where every subsequent put will put jobs into

    returns

    the tube's name

  39. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. def watch(tube: String): Future[Either[Reply, Int]]

    Permalink

    Start watching the given tube

    Start watching the given tube

    tube

    the tube name to watch

    returns

    the number of tubes now being watched, or an error reply

Inherited from AnyRef

Inherited from Any

Ungrouped