IdleConnectionFilter

Filter responsible for tracking idle connection, it will refuse requests and try to close idle connections based on the number of active connections.

Each time a message from a new connection arrive (based on nb of connections): - if below low watermark: accept the connection. - if above low watermark: collect (close) idle connections, but accept the connection. - if above high watermark: collect (close) idle connections, and refuse/accept the connection depending if we managed to close an idle connection.

NB: the connection is tracked after the server response, so that the server processing time is not count in the idle timeout.

Note: this will not properly handle multiple outstanding messages per connection and should not be used for duplex protocols such as finagle-mux.

Linear Supertypes

ServiceFactoryProxy[Req, Rep], ProxyServiceFactory[Req, Rep], Proxy, ServiceFactory[Req, Rep], Closable, (ClientConnection) ⇒ Future[Service[Req, Rep]], AnyRef, Any

Instance Constructors

new IdleConnectionFilter(self: ServiceFactory[Req, Rep], threshold: OpenConnectionsThresholds, statsReceiver: StatsReceiver = NullStatsReceiver)

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
def andThen[A](g: (Future[Service[Req, Rep]]) ⇒ A): (ClientConnection) ⇒ A

Definition Classes
Function1
Annotations
@unspecialized()
def apply(c: ClientConnection): Future[Service[Req, Rep]]

Reserve the use of a given service instance.
Reserve the use of a given service instance. This pins the underlying channel and the returned service has exclusive use of its underlying connection. To relinquish the use of the reserved Service, the user must call Service.close().

Definition Classes
IdleConnectionFilter → ProxyServiceFactory → ServiceFactory → Function1
final def apply(): Future[Service[Req, Rep]]

Definition Classes
ServiceFactory
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def close(deadline: Time): Future[Unit]

Definition Classes
ProxyServiceFactory → Closable
def close(after: Duration): Future[Unit]

Definition Classes
Closable
final def close(): Future[Unit]

Definition Classes
Closable
def compose[A](g: (A) ⇒ ClientConnection): (A) ⇒ Future[Service[Req, Rep]]

Definition Classes
Function1
Annotations
@unspecialized()
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
Proxy → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def flatMap[Req1, Rep1](f: (Service[Req, Rep]) ⇒ Future[Service[Req1, Rep1]]): ServiceFactory[Req1, Rep1]

Apply f on created services, returning the resulting Future in their stead.
Apply f on created services, returning the resulting Future in their stead. This is useful for implementing common factory wrappers that only need to modify or operate on the underlying service.

Definition Classes
ServiceFactory
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
Proxy → Any
final def isAvailable: Boolean

Definition Classes
ServiceFactory
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def map[Req1, Rep1](f: (Service[Req, Rep]) ⇒ Service[Req1, Rep1]): ServiceFactory[Req1, Rep1]

Map created services.
Map created services. Useful for implementing common styles of factory wrappers.

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def openConnections: Int
def self: ServiceFactory[Req, Rep]

Definition Classes
ServiceFactoryProxy → ProxyServiceFactory → Proxy
def status: Status

The current availability Status of this ServiceFactory
The current availability Status of this ServiceFactory

Definition Classes
ProxyServiceFactory → ServiceFactory
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def toService: Service[Req, Rep]

Make a service that after dispatching a request on that service, releases the service.
Make a service that after dispatching a request on that service, releases the service.

Definition Classes
ServiceFactory
def toString(): String

Definition Classes
Proxy → 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( ... )

Deprecated Value Members

final def make(): Future[Service[Req, Rep]]

Definition Classes
ServiceFactory
Annotations
@deprecated
Deprecated
(Since version 5.0.1) use apply() instead

Related Docs: object IdleConnectionFilter | package channel

class IdleConnectionFilter[Req, Rep] extends ServiceFactoryProxy[Req, Rep]

Instance Constructors

new IdleConnectionFilter(self: ServiceFactory[Req, Rep], threshold: OpenConnectionsThresholds, statsReceiver: StatsReceiver = NullStatsReceiver)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def andThen[A](g: (Future[Service[Req, Rep]]) ⇒ A): (ClientConnection) ⇒ A

def apply(c: ClientConnection): Future[Service[Req, Rep]]

final def apply(): Future[Service[Req, Rep]]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def close(deadline: Time): Future[Unit]

def close(after: Duration): Future[Unit]

final def close(): Future[Unit]

def compose[A](g: (A) ⇒ ClientConnection): (A) ⇒ Future[Service[Req, Rep]]

final def eq(arg0: AnyRef): Boolean

def equals(that: Any): Boolean

def finalize(): Unit

def flatMap[Req1, Rep1](f: (Service[Req, Rep]) ⇒ Future[Service[Req1, Rep1]]): ServiceFactory[Req1, Rep1]

final def getClass(): Class[_]

def hashCode(): Int

final def isAvailable: Boolean

final def isInstanceOf[T0]: Boolean

def map[Req1, Rep1](f: (Service[Req, Rep]) ⇒ Service[Req1, Rep1]): ServiceFactory[Req1, Rep1]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def openConnections: Int

def self: ServiceFactory[Req, Rep]

def status: Status

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

final def toService: Service[Req, Rep]

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Deprecated Value Members

final def make(): Future[Service[Req, Rep]]

Inherited from ServiceFactoryProxy[Req, Rep]

Inherited from ProxyServiceFactory[Req, Rep]

Inherited from Proxy

Inherited from ServiceFactory[Req, Rep]

Inherited from Closable

Inherited from (ClientConnection) ⇒ Future[Service[Req, Rep]]

Inherited from AnyRef

Inherited from Any

Ungrouped