Package org.eclipse.jetty.server.handler

Class StatisticsHandler.MinimumDataRateHandler

java.lang.Object
org.eclipse.jetty.util.component.AbstractLifeCycle
org.eclipse.jetty.util.component.ContainerLifeCycle
org.eclipse.jetty.server.Handler.Abstract
org.eclipse.jetty.server.Handler.AbstractContainer
org.eclipse.jetty.server.Handler.Wrapper
org.eclipse.jetty.server.handler.EventsHandler
org.eclipse.jetty.server.handler.StatisticsHandler
org.eclipse.jetty.server.handler.StatisticsHandler.MinimumDataRateHandler
All Implemented Interfaces:
Handler, Handler.Container, Handler.Singleton, Request.Handler, Container, Destroyable, Dumpable, Dumpable.DumpableContainer, LifeCycle, Invocable
Enclosing class:
StatisticsHandler
public static class StatisticsHandler.MinimumDataRateHandler extends StatisticsHandler
Checks that the wrapped handler can read/write at a minimal rate of N bytes per second. When reading or writing does not conform to the specified rates, this handler prevents further reads or writes by making them immediately fail.

  • Constructor Details

    • MinimumDataRateHandler

      public MinimumDataRateHandler(long minimumReadRate, long minimumWriteRate)
      Creates a MinimumDataRateHandler with the specified read and write rates.
      Parameters:
      minimumReadRate - the minimum number of bytes to be read per second, or 0 for not checking the read rate.
      minimumWriteRate - the minimum number of bytes to be written per second, or 0 for not checking the write rate.

    • MinimumDataRateHandler

      public MinimumDataRateHandler(Handler handler, long minimumReadRate, long minimumWriteRate)
      Creates a MinimumDataRateHandler with the specified read and write rates.
      Parameters:
      handler - the handler to wrap.
      minimumReadRate - the minimum number of bytes to be read per second, or 0 for not checking the read rate.
      minimumWriteRate - the minimum number of bytes to be written per second, or 0 for not checking the write rate.

  • Method Details

    • handle

      public boolean handle(Request request, Response response, Callback callback) throws Exception
      Description copied from interface: Request.Handler

      Invoked to handle the passed HTTP request and response.

      The request is accepted by returning true, then handling must be concluded by completing the passed callback. The handling may be asynchronous, i.e. this method may return true and complete the given callback later, possibly from a different thread. If this method returns false, then the callback must not be invoked and any mutation on the response reversed.

      Exceptions thrown by this method may be subsequently handled by an error Request.Handler, if present, otherwise a default HTTP 500 error is generated and the callback completed while writing the error response.

      The simplest implementation is:

       public boolean handle(Request request, Response response, Callback callback)
 {
     callback.succeeded();
     return true;
 }

      A HelloWorld implementation is:

       public boolean handle(Request request, Response response, Callback callback)
 {
     response.write(true, ByteBuffer.wrap("Hello World\n".getBytes(StandardCharsets.UTF_8)), callback);
     return true;
 }
      Specified by:
      handle in interface Request.Handler
      Overrides:
      handle in class EventsHandler
      Parameters:
      request - the HTTP request to handle
      response - the HTTP response to handle
      callback - the callback to complete when the handling is complete
      Returns:
      True if and only if the request will be handled, a response generated and the callback eventually called. This may occur within the scope of the call to this method, or asynchronously some time later. If false is returned, then this method must not generate a response, nor complete the callback.
      Throws:
      Exception - if there is a failure during the handling. Catchers cannot assume that the callback will be called and thus should attempt to complete the request as if a false had been returned.
      See Also: