RaftSystem

Value Members

final def !=(arg0: Any): Boolean

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

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

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

Definition Classes
Any
def clone(): AnyRef

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

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any
val leader: LeaderApi[T]
def leaderRoutes(supportValueFromText: (String) ⇒ T): LeaderRoutes[T]

supportValueFromText
the function used to create log entries of 'T' from user-specified text
returns
/rest/raft/leader/... routes to act as an edge-node for client requests
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val node: RaftNode[T] with LeaderApi[T]
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def raftRoutes: RaftRoutes[T]

returns
The /rest/raft/vote and /rest/raft/append routes required to exist for this endpoint to participate w/ other cluster nodes
def routes(supportValueFromText: (String) ⇒ T): Route

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.
supportValueFromText
a function which converts user input into a 'T', used in support routes for client requests
returns
the akka http routes
def start(valueFromString: (String) ⇒ T = RaftSystem.commandFromJsonText): Future[RunningService[RaftConfig, RaftNode[T] with LeaderApi[T]]]

valueFromString
a means to creates a T from the user's input field (for support routes only)
returns
the runninsert service. eventually. probably.
def supportRoutes: RaftSupportRoutes[T]

returns
the /rest/raft/support/... routes for support/debugging/dev purposes
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object RaftSystem | package state

class RaftSystem[T] extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

val leader: LeaderApi[T]

def leaderRoutes(supportValueFromText: (String) ⇒ T): LeaderRoutes[T]

final def ne(arg0: AnyRef): Boolean

val node: RaftNode[T] with LeaderApi[T]

final def notify(): Unit

final def notifyAll(): Unit

def raftRoutes: RaftRoutes[T]

def routes(supportValueFromText: (String) ⇒ T): Route

def start(valueFromString: (String) ⇒ T = RaftSystem.commandFromJsonText): Future[RunningService[RaftConfig, RaftNode[T] with LeaderApi[T]]]

def supportRoutes: RaftSupportRoutes[T]

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped