case class Server(stack: Stack[ServiceFactory[Request, Response]] = Server.stack, params: Params = Server.params) extends StdStackServer[Request, Response, Server] with Product with Serializable
- Alphabetic
- By Inheritance
- Server
- Serializable
- Product
- Equals
- StdStackServer
- ListeningStackServer
- WithServerAdmissionControl
- WithServerSession
- WithServerTransport
- CommonParams
- StackServer
- StackBasedServer
- Transformable
- Parameterized
- Server
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Server(stack: Stack[ServiceFactory[Request, Response]] = Server.stack, params: Params = Server.params)
Type Members
- type Context = TransportContext
The type of the transport's context.
The type of the transport's context.
- Attributes
- protected
- Definition Classes
- Server → StdStackServer
- type In = Any
The type we write into the transport.
The type we write into the transport.
- Attributes
- protected
- Definition Classes
- Server → StdStackServer
- type Out = Any
The type we read out of the transport.
The type we read out of the transport.
- Attributes
- protected
- Definition Classes
- Server → StdStackServer
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 addServerToRegistry(listenerName: String): Unit
Export info about the listener type to the global registry.
Export info about the listener type to the global registry.
The information about its implementation can then be queried at runtime.
- Attributes
- protected
- Definition Classes
- ListeningStackServer
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def configured[P](psp: (P, Param[P])): Server
Creates a new StackServer with parameter
psp._1
and Stack Param typepsp._2
.Creates a new StackServer with parameter
psp._1
and Stack Param typepsp._2
.- Definition Classes
- Server → ListeningStackServer → StackServer → Parameterized
- def configured[P](p: P)(implicit arg0: Param[P]): Server
Creates a new StackServer with parameter
p
.Creates a new StackServer with parameter
p
.- Definition Classes
- ListeningStackServer → StackServer → Parameterized
- def configuredParams(newParams: Params): Server
Creates a new StackServer with additional parameters
newParams
.Creates a new StackServer with additional parameters
newParams
.- Definition Classes
- Server → ListeningStackServer → StackServer → Parameterized
- def copy1(stack: Stack[ServiceFactory[Request, Response]] = this.stack, params: Params = this.params): Server
A copy constructor in lieu of defining StackServer as a case class.
A copy constructor in lieu of defining StackServer as a case class.
- Attributes
- protected
- Definition Classes
- Server → ListeningStackServer
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def newDispatcher(transport: Transport[In, Out] { type Context <: Server.this.Context }, service: Service[Request, Response]): HttpServerDispatcher
Defines a dispatcher, a function which binds a transport to a com.twitter.finagle.Service.
Defines a dispatcher, a function which binds a transport to a com.twitter.finagle.Service. Together with a
Listener
, it forms the foundation of a finagle server. Concrete implementations are expected to specify this.- Attributes
- protected
- Definition Classes
- Server → StdStackServer
- Note
The dispatcher must be prepared to handle the situation where it receives an already-closed transport.
- See also
- def newListener(): Listener[Any, Any, TransportContext]
Defines a typed com.twitter.finagle.server.Listener for this server.
Defines a typed com.twitter.finagle.server.Listener for this server. Concrete StackServer implementations are expected to specify this.
- Attributes
- protected
- Definition Classes
- Server → StdStackServer
- final def newListeningServer(serviceFactory: ServiceFactory[Request, Response], addr: SocketAddress)(trackSession: (ClientConnection) => Unit): ListeningServer
Constructs a new
ListeningServer
from theServiceFactory
.Constructs a new
ListeningServer
from theServiceFactory
. Each new session is passed to thetrackSession
function exactly once to facilitate connection resource management.- Attributes
- protected
- Definition Classes
- StdStackServer → ListeningStackServer
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val params: Params
The current parameter map used in this StackServer.
The current parameter map used in this StackServer.
- Definition Classes
- Server → StackServer → Parameterized
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def serve(addr: SocketAddress, factory: ServiceFactory[Request, Response]): ListeningServer
Serve
service
ataddr
Serve
service
ataddr
- Definition Classes
- Server → ListeningStackServer → Server
- final def serve(addr: String, service: Service[Request, Response]): ListeningServer
Serve
service
ataddr
Serve
service
ataddr
- Definition Classes
- Server
- final def serve(addr: String, service: ServiceFactory[Request, Response]): ListeningServer
Serve
service
ataddr
Serve
service
ataddr
- Definition Classes
- Server
- final def serve(addr: SocketAddress, service: Service[Request, Response]): ListeningServer
Serve
service
ataddr
Serve
service
ataddr
- Definition Classes
- Server
- def serveAndAnnounce(name: String, service: Service[Request, Response]): ListeningServer
Serve
service
ataddr
and announce withname
.Serve
service
ataddr
and announce withname
. Announcements will be removed when the service is closed. Omitting theaddr
will bind to an ephemeral port.- Definition Classes
- Server
- def serveAndAnnounce(name: String, service: ServiceFactory[Request, Response]): ListeningServer
Serve
service
ataddr
and announce withname
.Serve
service
ataddr
and announce withname
. Announcements will be removed when the service is closed. Omitting theaddr
will bind to an ephemeral port.- Definition Classes
- Server
- def serveAndAnnounce(name: String, addr: String, service: Service[Request, Response]): ListeningServer
Serve
service
ataddr
and announce withname
.Serve
service
ataddr
and announce withname
. Announcements will be removed when the service is closed. Omitting theaddr
will bind to an ephemeral port.- Definition Classes
- Server
- def serveAndAnnounce(name: String, addr: String, service: ServiceFactory[Request, Response]): ListeningServer
Serve
service
ataddr
and announce withname
.Serve
service
ataddr
and announce withname
. Announcements will be removed when the service is closed. Omitting theaddr
will bind to an ephemeral port.- Definition Classes
- Server
- def serveAndAnnounce(name: String, addr: SocketAddress, service: Service[Request, Response]): ListeningServer
Serve
service
ataddr
and announce withname
.Serve
service
ataddr
and announce withname
. Announcements will be removed when the service is closed. Omitting theaddr
will bind to an ephemeral port.- Definition Classes
- Server
- def serveAndAnnounce(name: String, addr: SocketAddress, service: ServiceFactory[Request, Response]): ListeningServer
Serve
service
ataddr
and announce withname
.Serve
service
ataddr
and announce withname
. Announcements will be removed when the service is closed. Omitting theaddr
will bind to an ephemeral port.- Definition Classes
- Server
- val stack: Stack[ServiceFactory[Request, Response]]
The current stack used in this StackServer.
The current stack used in this StackServer.
- Definition Classes
- Server → StackServer
- def superServe(addr: SocketAddress, factory: ServiceFactory[Request, Response]): ListeningServer
- Attributes
- protected
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def transformed(t: Transformer): Server
- Definition Classes
- ListeningStackServer → StackServer → Transformable
- See also
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- val withAdmissionControl: ServerAdmissionControlParams[Server]
An entry point for configuring the servers' admission control.
An entry point for configuring the servers' admission control.
- Definition Classes
- Server → WithServerAdmissionControl
- def withCompressionLevel(level: Int): Server
The compression level to use.
The compression level to use. If passed the default value (-1) then it will use TextualContentCompressor which will compress text-like content-types with the default compression level (6). Otherwise, use the Netty
HttpContentCompressor
for all content-types with specified compression level. - def withDecompression(enabled: Boolean): Server
Enables decompression of http content bodies.
- def withExceptionStatsHandler(exceptionStatsHandler: ExceptionStatsHandler): Server
Configures this server or client with given exception stats handler.
Configures this server or client with given exception stats handler.
- Definition Classes
- Server → CommonParams
- def withExecutionOffloaded(pool: FuturePool): Server
Configures this server or client to shift user-defined computation (com.twitter.util.Future callbacks and transformations) off of IO threads into a given FuturePool.
Configures this server or client to shift user-defined computation (com.twitter.util.Future callbacks and transformations) off of IO threads into a given FuturePool.
By default, Finagle executes all futures in the IO threads, minimizing context switches. Given there is usually a fixed number of IO threads shared across a JVM process, it's critically important to ensure they aren't being blocked by the application code, affecting system's responsiveness. Shifting application-level work onto a dedicated FuturePool or ExecutorService offloads IO threads, which may improve throughput in CPU-bound systems.
As always, run your own tests before enabling this feature.
- Definition Classes
- Server → CommonParams
- def withExecutionOffloaded(executor: ExecutorService): Server
Configures this server or client to shift user-defined computation (com.twitter.util.Future callbacks and transformations) off of IO threads into a given ExecutorService.
Configures this server or client to shift user-defined computation (com.twitter.util.Future callbacks and transformations) off of IO threads into a given ExecutorService.
By default, Finagle executes all futures in the IO threads, minimizing context switches. Given there is usually a fixed number of IO threads shared across a JVM process, it's critically important to ensure they aren't being blocked by the application code, affecting system's responsiveness. Shifting application-level work onto a dedicated FuturePool or ExecutorService offloads IO threads, which may improve throughput in CPU-bound systems.
As always, run your own tests before enabling this feature.
- Definition Classes
- Server → CommonParams
- def withHttp2: Server
Enable HTTP/2
Enable HTTP/2
- Note
this will override whatever has been set in the toggle.
- def withHttpStats: Server
Enable the collection of HTTP specific metrics.
Enable the collection of HTTP specific metrics. See http.filter.StatsFilter.
- def withKerberos(serverKerberosConfiguration: ServerKerberosConfiguration): Server
Enable kerberos server authentication for http requests
- def withLabel(label: String): Server
Configures this server or client with given
label
(default: empty string).Configures this server or client with given
label
(default: empty string).The
label
value is used for stats reporting to scope stats reported from different clients/servers to a single stats receiver.- Definition Classes
- Server → CommonParams
- def withLabels(keywords: String*): Server
- Definition Classes
- CommonParams
- def withMaxHeaderSize(size: StorageUnit): Server
For HTTP1*, configures the max size of headers For HTTP2, sets the MAX_HEADER_LIST_SIZE setting which is the maximum number of uncompressed bytes of header name/values.
For HTTP1*, configures the max size of headers For HTTP2, sets the MAX_HEADER_LIST_SIZE setting which is the maximum number of uncompressed bytes of header name/values. These may be set independently via the .configured API.
- def withMaxInitialLineSize(size: StorageUnit): Server
Configures the maximum initial http line length the server is willing to accept.
- def withMaxRequestSize(size: StorageUnit): Server
Configures the maximum request size this server can receive.
- def withMonitor(monitor: Monitor): Server
Configures this server or client with given util.Monitor (default: com.twitter.finagle.util.NullMonitor).
Configures this server or client with given util.Monitor (default: com.twitter.finagle.util.NullMonitor).
Monitors are Finagle's out-of-band exception reporters. Whenever an exception is thrown on a request path, it's reported to the monitor. The configured
Monitor
is composed (see below for how composition works) with the default monitor implementation, com.twitter.finagle.util.DefaultMonitor, which logs these exceptions.Monitors are wired into the server or client stacks via com.twitter.finagle.filter.MonitorFilter and are applied to the following kinds of exceptions:
- Synchronous exceptions thrown on request path,
Service.apply(request)
- Asynchronous exceptions (failed futures) thrown on request path,
Service.apply(request)
- Exceptions thrown from
respond
,onSuccess
,onFailure
future callbacks - Fatal exceptions thrown from
map
,flatMap
,transform
future continuations
Put it this way, we apply
Monitor.handle
to an exception if we would otherwise "lose" it, i.e. when it's not connected to theFuture
, nor is it connected to the call stack.You can compose multiple monitors if you want to extend or override the standard behavior, defined in
DefaultMonitor
.import com.twitter.util.Monitor val consoleMonitor = new Monitor { def handle(exc: Throwable): Boolean = { Console.err.println(exc.toString) false // continue handling with the next monitor (usually DefaultMonitor) } } $.withMonitor(consoleMonitor)
Returning
true
form within a monitor effectively terminates the monitor chain so no exceptions are propagated down to the next monitor.- Definition Classes
- Server → CommonParams
- Synchronous exceptions thrown on request path,
- def withNoAutomaticContinue: Server
By default finagle-http automatically sends 100-CONTINUE responses to inbound requests which set the 'Expect: 100-Continue' header.
By default finagle-http automatically sends 100-CONTINUE responses to inbound requests which set the 'Expect: 100-Continue' header. Streaming servers will always return 100-CONTINUE. Non-streaming servers will compare the content-length header to the configured limit (see:
withMaxRequestSize
) and send either a 100-CONTINUE or 413-REQUEST ENTITY TOO LARGE as appropriate. This method disables those automatic responses.- Note
Servers operating as proxies should disable automatic responses in order to allow origin servers to determine whether the expectation can be met.
,Disabling automatic continues is only supported in com.twitter.finagle.Http.HttpImpl.Http11Impl servers.
- def withNoHttp2: Server
Disable HTTP/2
Disable HTTP/2
- Note
this will override whatever has been set in the toggle.
- def withNoTlsSnooping: Server
Disables TLS snooping for this server.
- def withParams(params: Params): Server
Creates a new StackServer with
params
used to configure this StackServer'sstack
.Creates a new StackServer with
params
used to configure this StackServer'sstack
.- Definition Classes
- ListeningStackServer → StackServer → Parameterized
- def withRequestTimeout(timeout: Duration): Server
Configures the request
timeout
of this server or client (default: unbounded).Configures the request
timeout
of this server or client (default: unbounded).If the request has not completed within the given
timeout
, the pending work will be interrupted via com.twitter.util.Future.raise.Client's Request Timeout
The client request timeout is the maximum amount of time given to a single request (if there are retries, they each get a fresh request timeout). The timeout is applied only after a connection has been acquired. That is: it is applied to the interval between the dispatch of the request and the receipt of the response.
Server's Request Timeout
The server request timeout is the maximum amount of time, a server is allowed to spend handling the incoming request. Using the Finagle terminology, this is an amount of time after which a non-satisfied future returned from the user-defined service times out.
- Definition Classes
- Server → CommonParams
- See also
https://twitter.github.io/finagle/guide/Clients.html#timeouts-expiration
- def withRequestTimeout(timeout: Tunable[Duration]): Server
Configures the Tunable request
timeout
of this server or client (if applying the Tunable produces a value ofNone
, an unbounded timeout is used for the request).Configures the Tunable request
timeout
of this server or client (if applying the Tunable produces a value ofNone
, an unbounded timeout is used for the request).If the request has not completed within the Duration resulting from
timeout.apply()
, the pending work will be interrupted via com.twitter.util.Future.raise.Client's Request Timeout
The client request timeout is the maximum amount of time given to a single request (if there are retries, they each get a fresh request timeout). The timeout is applied only after a connection has been acquired. That is: it is applied to the interval between the dispatch of the request and the receipt of the response.
Server's Request Timeout
The server request timeout is the maximum amount of time, a server is allowed to spend handling the incoming request. Using the Finagle terminology, this is an amount of time after which a non-satisfied future returned from the user-defined service times out.
- def withResponseClassifier(responseClassifier: ResponseClassifier): Server
Configure a com.twitter.finagle.service.ResponseClassifier which is used to determine the result of a request/response.
Configure a com.twitter.finagle.service.ResponseClassifier which is used to determine the result of a request/response.
This allows developers to give Finagle the additional application-specific knowledge necessary in order to properly classify responses. Without this, Finagle cannot make judgements about application-level failures as it only has a narrow understanding of failures (for example: transport level, timeouts, and nacks).
As an example take an HTTP server that returns a response with a 500 status code. To Finagle this is a successful request/response. However, the application developer may want to treat all 500 status codes as failures and can do so via setting a com.twitter.finagle.service.ResponseClassifier.
ResponseClassifier is a PartialFunction and as such multiple classifiers can be composed together via PartialFunction.orElse.
Response classification is independently configured on the client and server. For client-side response classification using com.twitter.finagle.builder.ClientBuilder, see
com.twitter.finagle.builder.ClientBuilder.responseClassifier
- Definition Classes
- Server → CommonParams
- Note
If unspecified, the default classifier is com.twitter.finagle.service.ResponseClassifier.Default which is a total function fully covering the input domain.
- See also
com.twitter.finagle.http.service.HttpResponseClassifier
for some HTTP classification tools.
- val withSession: ServerSessionParams[Server]
An entry point for configuring the client's sessions.
An entry point for configuring the client's sessions.
Session might be viewed as logical connection that wraps a physical connection (i.e., transport) and controls its lifecycle. Sessions are used in Finagle to maintain liveness, requests cancellation, draining, and many more.
The default setup for a Finagle server's sessions is to not put any timeouts on it.
- Definition Classes
- Server → WithServerSession
- def withStack(fn: (Stack[ServiceFactory[Request, Response]]) => Stack[ServiceFactory[Request, Response]]): Server
A new StackServer using the function to create a new Stack.
A new StackServer using the function to create a new Stack.
The input to
fn
is the client's current stack. This API allows for easier usage when writing code that uses method chaining.This method is similar to transformed while providing easier API ergonomics for one-off
Stack
changes.- Definition Classes
- Server → ListeningStackServer → StackServer
From Scala:
import com.twitter.finagle.Http Http.server.withStack(_.prepend(MyStackModule))
From Java:
import com.twitter.finagle.Http; import static com.twitter.util.Function.func; Http.server().withStack(func(stack -> stack.prepend(MyStackModule)));
- See also
withStack(Stack)
Example: - def withStack(stack: Stack[ServiceFactory[Request, Response]]): Server
A new StackServer with the provided Stack.
A new StackServer with the provided Stack.
- Definition Classes
- Server → ListeningStackServer → StackServer
- See also
withStack
that takes aFunction1
for a more ergonomic API when used with method chaining.
- def withStatsReceiver(statsReceiver: StatsReceiver): Server
Configures this server or client with given stats.StatsReceiver (default: stats.DefaultStatsReceiver).
Configures this server or client with given stats.StatsReceiver (default: stats.DefaultStatsReceiver).
- Definition Classes
- Server → CommonParams
- def withStreaming(fixedLengthStreamedAfter: StorageUnit): Server
Streaming allows applications to work with HTTP messages that have large (or infinite) content bodies.
Streaming allows applications to work with HTTP messages that have large (or infinite) content bodies.
This method configures
fixedLengthStreamedAfter
limit, which effectively turns on streaming (thinkwithStreaming(true)
). ThefixedLengthStreamedAfter
, however, disables streaming for sufficiently small messages of known fixed length.If
Content-Length
of a message does not exceedfixedLengthStreamedAfter
it is buffered and its content is available through Request.content or Request.contentString.Messages without
Content-Length
header are always streamed regardless of their actual content length and thefixedLengthStreamedAfter
value.Request.isChunked should be used to determine whether a message is streamed (
isChunked == true
) or buffered (isChunked == false
). - def withStreaming(enabled: Boolean): Server
Streaming allows applications to work with HTTP messages that have large (or infinite) content bodies.
Streaming allows applications to work with HTTP messages that have large (or infinite) content bodies.
If
enabled
is set totrue
, the message content is available through a com.twitter.io.Reader, which gives the application a handle to the byte stream.If
enabled
is set tofalse
, the entire message content is buffered up to maximum allowed message size. - def withTlsSnooping: Server
When enabled simultaneously with TLS (
withTransport.tls
), this server would use both cleartext and TLS socket connections on the same port (default:disabled
). - def withTracer(tracer: Tracer): Server
Configures this server or client with given tracing.Tracer (default: com.twitter.finagle.tracing.DefaultTracer).
Configures this server or client with given tracing.Tracer (default: com.twitter.finagle.tracing.DefaultTracer).
- Definition Classes
- Server → CommonParams
- Note
if you supply com.twitter.finagle.tracing.NullTracer, no trace information will be written, but this does not disable Finagle from propagating trace information. Instead, if traces are being aggregated across your fleet, it will orphan subsequent spans.
- val withTransport: ServerTransportParams[Server]
An entry point for configuring servers' com.twitter.finagle.transport.Transport.
An entry point for configuring servers' com.twitter.finagle.transport.Transport.
Transport
is a Finagle abstraction over the network connection (i.e., a TCP connection).- Definition Classes
- Server → WithServerTransport