Class/Object

miniraft.state

RaftSystem

Related Docs: object RaftSystem | package state

Permalink

class RaftSystem[T] extends AnyRef

Pulls together the different components of a Raft System as seen by a raft node.

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

Instance Constructors

  1. new RaftSystem(config: RaftConfig, asyncClient: RaftNodeActorClient[T], logic: RaftNodeLogic[T], protocol: BaseProtocol[T], locationForId: (NodeId) ⇒ HostLocation, saveDirAndCounterOpt: Option[(Path, AtomicInteger)])(implicit arg0: Encoder[T], arg1: Decoder[T])

    Permalink
    Attributes
    protected

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 clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def defaultEndpoint: RaftEndpoint[T]

    Permalink
  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. def leader: RaftNodeActorClient[T]

    Permalink
  14. def leaderClient(client: RestClient = config.clusterRestClient): LeaderClient[T]

    Permalink
  15. def leaderRoutes(leader: LeaderApi[T]): LeaderRoutes[T]

    Permalink

    returns

    /rest/raft/leader/... routes to act as an edge-node for client requests

  16. val logic: RaftNodeLogic[T]

    Permalink
  17. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  20. val protocol: BaseProtocol[T]

    Permalink
  21. def raftRoutes(endpoint: RaftEndpoint[T]): RaftRoutes[T]

    Permalink

    returns

    The /rest/raft/vote and /rest/raft/append routes required to exist for this endpoint to participate w/ other cluster nodes

  22. def routes(endpoint: RaftEndpoint[T] = defaultEndpoint, leader: LeaderApi[T] = asyncClient): Route

    Permalink

    Produces Akka HTTP routes based on the given config, raft node and protocol.

    Produces Akka HTTP routes based on the given config, raft node and protocol.

    The 'supportValueFromText' is used when support routes are enabled to allow users to poke the client API by making requests based on some text input (e.g. from an input field). It is not used when support routes are disabled.

    If not provided, the default is to use the implicit json encoder.

    returns

    the akka http routes

  23. def start(restRoutes: Route = routes()): Future[RunningService[RaftConfig, RaftSystem[T]]]

    Permalink

    returns

    the RunningService service. eventually. probably.

  24. def supportClient(client: RestClient = config.clusterRestClient): RaftSupportClient[T]

    Permalink
  25. def supportRoutes: RaftSupportRoutes[T]

    Permalink

    returns

    the /rest/raft/support/... routes for support/debugging/dev purposes

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

    Permalink
    Definition Classes
    AnyRef
  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