Class/Object

com.twitter.zk.coordination

ShardCoordinator

Related Docs: object ShardCoordinator | package coordination

Permalink

class ShardCoordinator extends AnyRef

A rudimentary shard/partition coordinator. Provides ShardPermits by lowest available ID first (linear scan).

val shardCoordinator = new ShardCoordinator(zkClient, "/testing/twitter/service/something/shards", numShards)
log.trace("Waiting for shard permit...")
shardCoordinator.acquire flatMap { shard =>
  log.trace("Working as shard %d", shard.id)
  { // inside some Future
    if (Hashing.consistentHash(item, numShards) == shard.id) action
  } ensure { shard.release }
}
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ShardCoordinator
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ShardCoordinator(zk: ZkClient, path: String, numShards: Int)

    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. def acquire(): Future[ShardPermit]

    Permalink

    Acquire a permit for a shard (ShardPermit) asynchronously.

    Acquire a permit for a shard (ShardPermit) asynchronously. A ShardPermit contains a zero-indexed shard ID. Be sure to call release() on the ShardPermit when your client is finished performing work for the shard.

    returns

    A Future of ShardPermit that is satisfied when a shard slot becomes available.

    Exceptions thrown

    RejectedExecutionException when a shard cannot be acquired due to an unexpected state in the zookeeper tree. Assumed to only happen if some zookeeper client clobbers the tree location for this ShardCoordinator.

    SemaphoreError when the underlying semaphore throws an exception.

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef

  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  17. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  18. final def wait(): Unit

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

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

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

  20. final def wait(arg0: Long): Unit

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

Inherited from AnyRef

Inherited from Any

Ungrouped