com.twitter.zk.coordination

ShardCoordinator

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
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

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

Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. def acquire(): Future[ShardPermit]

    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.

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  8. def clone(): AnyRef

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

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

    Definition Classes
    AnyRef

  10. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  11. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  13. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  14. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  16. final def notify(): Unit

    Definition Classes
    AnyRef

  17. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    AnyRef

  19. def toString(): String

    Definition Classes
    AnyRef → Any

  20. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped