BackpressureProtocols

Communication patterns based on backpressure.

Backpressure ensures that the backpressure server has a bound on the number of events in its event queue, at all times. This is achieved by preventing the clients from sending too many events.

Clients must ask the backpressure server for a backpressure link. When a client receives a link, it must check if it has sufficient budget to send events to the server, and potentially wait before sending an event. The budget is spent each time that the client sends an event, and replenished when the server sends a token.

There are several kinds of backpressure exposed by this module:

The for-all backpressure policy maintains a fixed number of tokens across all backpressure links. The advantage is that the server cannot be overwhelmed, regardless of the number of clients. The disadvantage is that some clients can fail while holding some of the tokens, in which case tokens are lost. If failures are possible in the system, such scenarios can ultimately starve the protocol.
The per-client backpressure policy maintains a fixed number of tokens per each backpressure link. The advantage is that the failure of any single client only obliviates the tokens from the client's own backpressure links, so other clients cannot be starved. The disadvantage is that the total number of clients may be unbounded, which can overwhelm the backpressure server.

Self Type: BackpressureProtocols with ServerProtocols

Linear Supertypes

AnyRef, Any

Type Members

implicit class BackpressureChannelBuilderOps extends AnyRef

Methods for creating backpressure channels.
implicit class BackpressureConnectorOps[T] extends AnyRef

Methods for starting backpressure protocols on backpressure channels.
implicit class BackpressureServerOps[T] extends AnyRef
implicit class BackpressureSystemOps extends AnyRef

Augments reactor systems with operations used to create backpressure reactors.

Value Members

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from BackpressureProtocols to any2stringadd[BackpressureProtocols] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (BackpressureProtocols, B)

Implicit information
This member is added by an implicit conversion from BackpressureProtocols to ArrowAssoc[BackpressureProtocols] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
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( ... )
def ensuring(cond: (BackpressureProtocols) ⇒ Boolean, msg: ⇒ Any): BackpressureProtocols

Implicit information
This member is added by an implicit conversion from BackpressureProtocols to Ensuring[BackpressureProtocols] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (BackpressureProtocols) ⇒ Boolean): BackpressureProtocols

Implicit information
This member is added by an implicit conversion from BackpressureProtocols to Ensuring[BackpressureProtocols] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): BackpressureProtocols

Implicit information
This member is added by an implicit conversion from BackpressureProtocols to Ensuring[BackpressureProtocols] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): BackpressureProtocols

Implicit information
This member is added by an implicit conversion from BackpressureProtocols to Ensuring[BackpressureProtocols] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
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] )
def formatted(fmtstr: String): String

Implicit information
This member is added by an implicit conversion from BackpressureProtocols to StringFormat[BackpressureProtocols] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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( ... )
def →[B](y: B): (BackpressureProtocols, B)

Implicit information
This member is added by an implicit conversion from BackpressureProtocols to ArrowAssoc[BackpressureProtocols] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

trait BackpressureProtocols extends AnyRef

Type Members

implicit class BackpressureChannelBuilderOps extends AnyRef

implicit class BackpressureConnectorOps[T] extends AnyRef

implicit class BackpressureServerOps[T] extends AnyRef

implicit class BackpressureSystemOps extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (BackpressureProtocols, B)

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def ensuring(cond: (BackpressureProtocols) ⇒ Boolean, msg: ⇒ Any): BackpressureProtocols

def ensuring(cond: (BackpressureProtocols) ⇒ Boolean): BackpressureProtocols

def ensuring(cond: Boolean, msg: ⇒ Any): BackpressureProtocols

def ensuring(cond: Boolean): BackpressureProtocols

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def →[B](y: B): (BackpressureProtocols, B)

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from BackpressureProtocols to any2stringadd[BackpressureProtocols]

Inherited by implicit conversion StringFormat from BackpressureProtocols to StringFormat[BackpressureProtocols]

Inherited by implicit conversion Ensuring from BackpressureProtocols to Ensuring[BackpressureProtocols]

Inherited by implicit conversion ArrowAssoc from BackpressureProtocols to ArrowAssoc[BackpressureProtocols]

Ungrouped