org.mashupbots.socko.handlers

StaticContentHandler

class StaticContentHandler extends Actor

Handles downloading of static files and resources.

To trigger a download, send a StaticFileRequest or StaticResourceRequest message from your routes.

StaticContentHandler performs HTTP compression and also uses the If-Modified-Since header for browser side caching.

Configuration

StaticContentHandler uses lots of disk IO (blocking code). Please run it using a router with PinnedDispatcher (a thread per actor) or BalancingDispatcher.

For example:

  router = actorSystem.actorOf(Props[StaticContentHandler]
           .withRouter(FromConfig()).withDispatcher("myDispatcher"), "myRouter")

Configuration in application.conf:

  myDispatcher {
    executor = "thread-pool-executor"
    type = PinnedDispatcher
  }

  akka {
    event-handlers = ["akka.event.slf4j.Slf4jEventHandler"]
    loglevel=DEBUG
    actor {
      deployment {
        /myRouter {
          router = round-robin
          nr-of-instances = 5
        }
      }
    }
  }

Caching Small Files

HTTP ETag header is used.

Request #1 Headers
------------------
GET /file1.txt HTTP/1.1

Response #1 Headers
------------------
HTTP/1.1 200 OK
Date:               Tue, 01 Mar 2011 22:44:26 GMT
ETag: "686897696a7c876b7e"
Expires:            Tue, 01 Mar 2012 22:44:26 GMT
Cache-Control:      private, max-age=31536000

Request #2 Headers
------------------
GET /file1.txt HTTP/1.1
If-None-Match: "686897696a7c876b7e"

Response #2 Headers
------------------
HTTP/1.1 304 Not Modified
Date:               Tue, 01 Mar 2011 22:44:28 GMT

Caching Big Files

HTTP If-Modified-Since header is used

Request #1 Headers
------------------
GET /file1.txt HTTP/1.1

Response #1 Headers
------------------
HTTP/1.1 200 OK
Date:               Tue, 01 Mar 2011 22:44:26 GMT
Last-Modified:      Wed, 30 Jun 2010 21:36:48 GMT
Expires:            Tue, 01 Mar 2012 22:44:26 GMT
Cache-Control:      private, max-age=31536000

Request #2 Headers
------------------
GET /file1.txt HTTP/1.1
If-Modified-Since:  Wed, 30 Jun 2010 21:36:48 GMT

Response #2 Headers
------------------
HTTP/1.1 304 Not Modified
Date:               Tue, 01 Mar 2011 22:44:28 GMT

Compression

HTTP Accept-Encoding header is used by the caller to nominate their supported compression algorithm. We return the compression format used in the Content-Encoding header.

Request
-------
GET /encrypted-area HTTP/1.1
Host: www.example.com
Accept-Encoding: gzip, deflate

Response
--------
HTTP/1.1 200 OK
Content-Encoding: gzip

Note

If a response includes both an Expires header and a max-age directive, the max-age directive overrides the Expires header, even if the Expires header is more restrictive

See HTTP Header Field Definitions

Linear Supertypes
Actor, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. StaticContentHandler
  2. Actor
  3. AnyRef
  4. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new StaticContentHandler ()

Type Members

  1. type Receive = PartialFunction[Any, Unit]

    Definition Classes
    Actor

Value Members

  1. def != (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any
  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  5. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  6. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any
  7. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  8. implicit val context : ActorContext

    Attributes
    protected[akka] implicit
    Definition Classes
    Actor
  9. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  10. def equals (arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  11. def finalize (): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  12. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef → Any
  13. def hashCode (): Int

    Definition Classes
    AnyRef → Any
  14. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any
  15. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  16. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  17. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  18. def postRestart (reason: Throwable): Unit

    Definition Classes
    Actor
  19. def postStop (): Unit

    Definition Classes
    Actor
  20. def preRestart (reason: Throwable, message: Option[Any]): Unit

    Definition Classes
    Actor
  21. def preStart (): Unit

    Definition Classes
    Actor
  22. def receive : PartialFunction[Any, Unit]

    Only takes StaticFileRequest or messages.

    Only takes StaticFileRequest or messages.

    Definition Classes
    StaticContentHandler → Actor
  23. implicit val self : ActorRef

    Attributes
    implicit final
    Definition Classes
    Actor
  24. def sender : ActorRef

    Attributes
    final
    Definition Classes
    Actor
  25. def supervisorStrategy (): SupervisorStrategy

    Definition Classes
    Actor
  26. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef
  27. def toString (): String

    Definition Classes
    AnyRef → Any
  28. def unhandled (message: Any): Unit

    Definition Classes
    Actor
  29. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  30. def wait (arg0: Long, arg1: Int): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  31. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from Actor

Inherited from AnyRef

Inherited from Any