Package org.atmosphere.cpr

Interface AsyncSupport<E extends AtmosphereResource>

All Known Implementing Classes:
AsynchronousProcessor, BlockingIOCometSupport, JSR356AsyncSupport, NettyCometSupport, Servlet30CometSupport
public interface AsyncSupport<E extends AtmosphereResource>
Atmosphere's supported WebServer must implement this interface in order to be auto detected by the AtmosphereFramework. If the AtmosphereFramework fail to detect the AsyncSupport, it will use a blocking thread approach to emulate Comet using the BlockingIOCometSupport.

Framework designers or Atmosphere application developers can also add their own implementation of that class by referencing their class within the atmosphere.xml file: 


 invalid input: '<'<atmosphere-handler ... comet-support="your.class.name">

Author:
Jeanfrancois Arcand

  • Method Details

    • getContainerName

      String getContainerName()
      Return the name of the Java Web Server.
      Returns:
      the name of the Java Web Server.

    • init

      void init(jakarta.servlet.ServletConfig sc) throws jakarta.servlet.ServletException
      Initialize the WebServer using the ServletConfig
      Parameters:
      sc - the ServletConfig
      Throws:
      jakarta.servlet.ServletException

    • service

      Action service(AtmosphereRequest req, AtmosphereResponse res) throws IOException, jakarta.servlet.ServletException
      Serve the AtmosphereRequest and the AtmosphereResponse and return the appropriate Action.
      Parameters:
      req - the AtmosphereRequest
      res - the AtmosphereResponse
      Returns:
      the Action that was manipulated by the AtmosphereHandler
      Throws:
      IOException
      jakarta.servlet.ServletException

    • action

      void action(E actionEvent)
      Process an Action from an ActionEvent operation like suspend, resume or timed out.
      Parameters:
      actionEvent - An instance of Action

    • supportWebSocket

      boolean supportWebSocket()
      Return true if this implementation supports the websocket protocol.
      Returns:
      true if supported

    • complete

      AsyncSupport complete(E r)
      Complete and close the connection associated with an implementation of AtmosphereResource
      Parameters:
      r - AtmosphereResource
      Returns:
      this