ServerBuilder

A handy Builder for constructing Servers (i.e., binding Services to a port). This class is subclassable. Override copy() and build() to do your own dirty work.

The main class to use is com.twitter.finagle.builder.ServerBuilder, as so

ServerBuilder()
  .codec(Http)
  .hostConnectionMaxLifeTime(5.minutes)
  .readTimeout(2.minutes)
  .name("servicename")
  .bindTo(new InetSocketAddress(serverPort))
  .build(plusOneService)

The ServerBuilder requires the definition of codec, bindTo and name. In Scala, these are statically type checked, and in Java the lack of any of the above causes a runtime error.

The build method uses an implicit argument to statically typecheck the builder (to ensure completeness, see above). The Java compiler cannot provide such implicit, so we provide a separate function in Java to accomplish this. Thus, the Java code for the above is

ServerBuilder.safeBuild(
 plusOneService,
 ServerBuilder.get()
  .codec(Http)
  .hostConnectionMaxLifeTime(5.minutes)
  .readTimeout(2.minutes)
  .name("servicename")
  .bindTo(new InetSocketAddress(serverPort)));

Alternatively, using the unsafeBuild method on ServerBuilder verifies the builder dynamically, resulting in a runtime error instead of a compiler error.

Defaults

The following defaults are applied to servers constructed via ServerBuilder, unless overridden with the corresponding method. These defaults were chosen carefully so as to work well for most use cases. Before changing any of them, make sure that you know exactly how they will affect your application -- these options are typically only changed by expert users.

- openConnectionsThresholds: None - maxConcurrentRequests: Int.MaxValue - backlog: OS-defined default value

Linear Supertypes

AnyRef, Any

Type Members

type FullySpecifiedConfig = ServerConfig[Req, Rep, Yes, Yes, Yes]
type This = ServerBuilder[Req, Rep, HasCodec, HasBindTo, HasName]
type ThisConfig = ServerConfig[Req, Rep, HasCodec, HasBindTo, HasName]

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 backlog(value: Int): This
def bindTo(address: SocketAddress): ServerBuilder[Req, Rep, HasCodec, Yes, HasName]
def build(serviceFactory: ServiceFactory[Req, Rep])(implicit THE_BUILDER_IS_NOT_FULLY_SPECIFIED_SEE_ServerBuilder_DOCUMENTATION: ServerConfigEvidence[HasCodec, HasBindTo, HasName]): Server

Construct the Server, given the provided ServiceFactory.
Construct the Server, given the provided ServiceFactory. This is useful if the protocol is stateful (e.g., requires authentication or supports transactions).
def build(service: Service[Req, Rep])(implicit THE_BUILDER_IS_NOT_FULLY_SPECIFIED_SEE_ServerBuilder_DOCUMENTATION: ServerConfigEvidence[HasCodec, HasBindTo, HasName]): Server

Construct the Server, given the provided Service.
def cancelOnHangup(yesOrNo: Boolean): This

Cancel pending futures whenever the the connection is shut down.
Cancel pending futures whenever the the connection is shut down. This defaults to true.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def codec[Req1, Rep1](codecFactory: (ServerCodecConfig) ⇒ Codec[Req1, Rep1]): ServerBuilder[Req1, Rep1, Yes, HasBindTo, HasName]
def codec[Req1, Rep1](codecFactory: CodecFactory[Req1, Rep1]): ServerBuilder[Req1, Rep1, Yes, HasBindTo, HasName]
def codec[Req1, Rep1](codec: Codec[Req1, Rep1]): ServerBuilder[Req1, Rep1, Yes, HasBindTo, HasName]
def configured[P, HasCodec1, HasBindTo1, HasName1](param: P)(implicit arg0: Param[P]): ServerBuilder[Req, Rep, HasCodec1, HasBindTo1, HasName1]

Attributes
protected
def copy[Req1, Rep1, HasCodec1, HasBindTo1, HasName1](ps: Params, newServer: (Params) ⇒ finagle.Server[Req1, Rep1]): ServerBuilder[Req1, Rep1, HasCodec1, HasBindTo1, HasName1]

Attributes
protected
def daemon(daemonize: Boolean): This

When true, the server is daemonized.
When true, the server is daemonized. As with java threads, a process can only exit only when all remaining servers are daemonized. False by default.
def enableAdmissionControl(enable: Boolean): This

Configure admission control filters in the server Stack.
Configure admission control filters in the server Stack.

See also
com.twitter.finagle.filter.ServerAdmissionControl
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def exceptionCategorizer(exceptionStatsHandler: ExceptionStatsHandler): This

Provide an alternative to putting all request exceptions under a "failures" stat.
Provide an alternative to putting all request exceptions under a "failures" stat. Typical implementations may report any cancellations or validation errors separately so success rate considers only valid non cancelled requests.
exceptionStatsHandler
function to record failure details.
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
def hostConnectionMaxIdleTime(howlong: Duration): This
def hostConnectionMaxLifeTime(howlong: Duration): This
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def keepAlive(value: Boolean): This
def logChannelActivity(v: Boolean): This
def logger(logger: Logger): This
def maxConcurrentRequests(max: Int): This

Configures the maximum concurrent requests that are admitted by the server at any given time.
Configures the maximum concurrent requests that are admitted by the server at any given time. If the server receives a burst of traffic that exceeds this limit, the burst is rejected with a Failure.Rejected exception. Note, this failure signals a graceful rejection which is transmitted to clients by certain protocols in Finagle (e.g. Http, ThriftMux).
def monitor(mFactory: (String, SocketAddress) ⇒ Monitor): This
def name(value: String): ServerBuilder[Req, Rep, HasCodec, HasBindTo, Yes]
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def newFinagleSslEngine(v: () ⇒ Engine): This
def newSslEngine(newSsl: () ⇒ SSLEngine): This

Provide a raw SSL engine that is used to establish SSL sessions.
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def openConnectionsThresholds(thresholds: OpenConnectionsThresholds): This
val params: Params
def readTimeout(howlong: Duration): This
def recvBufferSize(value: Int): This
def reportTo(receiver: StatsReceiver): This
def requestTimeout(howlong: Duration): This
def sendBufferSize(value: Int): This
def stack[Req1, Rep1](server: StackBasedServer[Req1, Rep1]): ServerBuilder[Req1, Rep1, Yes, HasBindTo, HasName]

Overrides the stack and com.twitter.finagle.Server that will be used by this builder.
Overrides the stack and com.twitter.finagle.Server that will be used by this builder.
server
A StackBasedServer representation of a com.twitter.finagle.Server. server is materialized with the state of configuration when build is called. There is no guarantee that all builder parameters will be used by the resultant Server; it is up to the discretion of server itself and the protocol implementation.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def tls(certificatePath: String, keyPath: String, caCertificatePath: String = null, ciphers: String = null, nextProtos: String = null): This
def toString(): String

Definition Classes
ServerBuilder → AnyRef → Any
def tracer(t: Tracer): This
def trafficClass(value: Option[Int]): This

Configures the traffic class.
Configures the traffic class.

See also
Listener.TrafficClass
def unsafeBuild(service: Service[Req, Rep]): Server

Construct a Service, with runtime checks for builder completeness.
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 writeCompletionTimeout(howlong: Duration): This

Deprecated Value Members

def build(serviceFactory: ServiceFactory[Req, Rep], THE_BUILDER_IS_NOT_FULLY_SPECIFIED_SEE_ServerBuilder_DOCUMENTATION: =:=[ThisConfig, FullySpecifiedConfig]): Server

Annotations
@deprecated
Deprecated
(Since version 5.0.1) Used for ABI compat
def build(serviceFactory: (ClientConnection) ⇒ Service[Req, Rep])(implicit THE_BUILDER_IS_NOT_FULLY_SPECIFIED_SEE_ServerBuilder_DOCUMENTATION: =:=[ThisConfig, FullySpecifiedConfig]): Server

Construct the Server, given the provided ServiceFactory.
Construct the Server, given the provided ServiceFactory. This is useful if the protocol is stateful (e.g., requires authentication or supports transactions).

Annotations
@deprecated
Deprecated
(Since version 5.0.1) Use the ServiceFactory variant instead
def build(serviceFactory: () ⇒ Service[Req, Rep])(implicit THE_BUILDER_IS_NOT_FULLY_SPECIFIED_SEE_ServerBuilder_DOCUMENTATION: =:=[ThisConfig, FullySpecifiedConfig]): Server

Construct the Server, given the provided Service factory.
Construct the Server, given the provided Service factory.

Annotations
@deprecated
Deprecated
(Since version 5.0.1) Use the ServiceFactory variant instead
def build(service: Service[Req, Rep], THE_BUILDER_IS_NOT_FULLY_SPECIFIED_SEE_ServerBuilder_DOCUMENTATION: =:=[ThisConfig, FullySpecifiedConfig]): Server

Annotations
@deprecated
Deprecated
(Since version 5.0.1) Used for ABI compat
def channelFactory(cf: ServerChannelFactory): This

Annotations
@deprecated
Deprecated
(Since version 2015-11-18) use com.twitter.finagle.netty3.numWorkers flag instead
def stack[Req1, Rep1](mk: (Params) ⇒ finagle.Server[Req1, Rep1]): ServerBuilder[Req1, Rep1, Yes, HasBindTo, HasName]

Overrides the stack and com.twitter.finagle.Server that will be used by this builder.
Overrides the stack and com.twitter.finagle.Server that will be used by this builder.
mk
A function that materializes a Server from a set of Params. mk is passed the state of configuration when build is called. There is no guarantee that all the builder parameters will be used by the server created by mk; it is up to the discretion of the server and protocol implementation.

Annotations
@deprecated
Deprecated
(Since version 7.0.0) Use stack(server: StackBasedServer)
def tracerFactory(t: Tracer): This

Annotations
@deprecated
Deprecated
(Since version 7.0.0) Use tracer() instead
def tracerFactory(factory: Factory): This

Annotations
@deprecated
Deprecated
(Since version 7.0.0) Use tracer() instead

Related Docs: object ServerBuilder | package builder

class ServerBuilder[Req, Rep, HasCodec, HasBindTo, HasName] extends AnyRef

Defaults

Type Members

type FullySpecifiedConfig = ServerConfig[Req, Rep, Yes, Yes, Yes]

type This = ServerBuilder[Req, Rep, HasCodec, HasBindTo, HasName]

type ThisConfig = ServerConfig[Req, Rep, HasCodec, HasBindTo, HasName]

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def backlog(value: Int): This

def bindTo(address: SocketAddress): ServerBuilder[Req, Rep, HasCodec, Yes, HasName]

def build(serviceFactory: ServiceFactory[Req, Rep])(implicit THE_BUILDER_IS_NOT_FULLY_SPECIFIED_SEE_ServerBuilder_DOCUMENTATION: ServerConfigEvidence[HasCodec, HasBindTo, HasName]): Server

def build(service: Service[Req, Rep])(implicit THE_BUILDER_IS_NOT_FULLY_SPECIFIED_SEE_ServerBuilder_DOCUMENTATION: ServerConfigEvidence[HasCodec, HasBindTo, HasName]): Server

def cancelOnHangup(yesOrNo: Boolean): This

def clone(): AnyRef

def codec[Req1, Rep1](codecFactory: (ServerCodecConfig) ⇒ Codec[Req1, Rep1]): ServerBuilder[Req1, Rep1, Yes, HasBindTo, HasName]

def codec[Req1, Rep1](codecFactory: CodecFactory[Req1, Rep1]): ServerBuilder[Req1, Rep1, Yes, HasBindTo, HasName]

def codec[Req1, Rep1](codec: Codec[Req1, Rep1]): ServerBuilder[Req1, Rep1, Yes, HasBindTo, HasName]

def configured[P, HasCodec1, HasBindTo1, HasName1](param: P)(implicit arg0: Param[P]): ServerBuilder[Req, Rep, HasCodec1, HasBindTo1, HasName1]

def copy[Req1, Rep1, HasCodec1, HasBindTo1, HasName1](ps: Params, newServer: (Params) ⇒ finagle.Server[Req1, Rep1]): ServerBuilder[Req1, Rep1, HasCodec1, HasBindTo1, HasName1]

def daemon(daemonize: Boolean): This

def enableAdmissionControl(enable: Boolean): This

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def exceptionCategorizer(exceptionStatsHandler: ExceptionStatsHandler): This

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

def hostConnectionMaxIdleTime(howlong: Duration): This

def hostConnectionMaxLifeTime(howlong: Duration): This

final def isInstanceOf[T0]: Boolean

def keepAlive(value: Boolean): This

def logChannelActivity(v: Boolean): This

def logger(logger: Logger): This

def maxConcurrentRequests(max: Int): This

def monitor(mFactory: (String, SocketAddress) ⇒ Monitor): This

def name(value: String): ServerBuilder[Req, Rep, HasCodec, HasBindTo, Yes]

final def ne(arg0: AnyRef): Boolean

def newFinagleSslEngine(v: () ⇒ Engine): This

def newSslEngine(newSsl: () ⇒ SSLEngine): This

final def notify(): Unit

final def notifyAll(): Unit

def openConnectionsThresholds(thresholds: OpenConnectionsThresholds): This

val params: Params

def readTimeout(howlong: Duration): This

def recvBufferSize(value: Int): This

def reportTo(receiver: StatsReceiver): This

def requestTimeout(howlong: Duration): This

def sendBufferSize(value: Int): This

def stack[Req1, Rep1](server: StackBasedServer[Req1, Rep1]): ServerBuilder[Req1, Rep1, Yes, HasBindTo, HasName]

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

def tls(certificatePath: String, keyPath: String, caCertificatePath: String = null, ciphers: String = null, nextProtos: String = null): This

def toString(): String

def tracer(t: Tracer): This

def trafficClass(value: Option[Int]): This

def unsafeBuild(service: Service[Req, Rep]): Server

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def writeCompletionTimeout(howlong: Duration): This

Deprecated Value Members

def build(serviceFactory: ServiceFactory[Req, Rep], THE_BUILDER_IS_NOT_FULLY_SPECIFIED_SEE_ServerBuilder_DOCUMENTATION: =:=[ThisConfig, FullySpecifiedConfig]): Server

def build(serviceFactory: (ClientConnection) ⇒ Service[Req, Rep])(implicit THE_BUILDER_IS_NOT_FULLY_SPECIFIED_SEE_ServerBuilder_DOCUMENTATION: =:=[ThisConfig, FullySpecifiedConfig]): Server

def build(serviceFactory: () ⇒ Service[Req, Rep])(implicit THE_BUILDER_IS_NOT_FULLY_SPECIFIED_SEE_ServerBuilder_DOCUMENTATION: =:=[ThisConfig, FullySpecifiedConfig]): Server

def build(service: Service[Req, Rep], THE_BUILDER_IS_NOT_FULLY_SPECIFIED_SEE_ServerBuilder_DOCUMENTATION: =:=[ThisConfig, FullySpecifiedConfig]): Server

def channelFactory(cf: ServerChannelFactory): This

def stack[Req1, Rep1](mk: (Params) ⇒ finagle.Server[Req1, Rep1]): ServerBuilder[Req1, Rep1, Yes, HasBindTo, HasName]

def tracerFactory(t: Tracer): This

def tracerFactory(factory: Factory): This

Inherited from AnyRef

Inherited from Any

Ungrouped