org.mashupbots.socko.webserver

WebServerConfig

case class WebServerConfig (serverName: String, hostname: String, port: Int, sslConfig: Option[SslConfig], httpConfig: HttpConfig) extends Extension with Product with Serializable

Web server configuration

The configuration can be optionally loaded from Akka's application.conf file. The following configuration file: {{{ akka-config-example { server-name=AkkaConfigExample hostname=localhost port=9000 } }}} can be loaded as follows: {{{ object MyWebServerConfig extends ExtensionId[WebServerConfig] with ExtensionIdProvider { override def lookup = MyWebServerConfig override def createExtension(system: ExtendedActorSystem) = new WebServerConfig(system.settings.config, "akka-config-example") } val myWebServerConfig = MyWebServerConfig(actorSystem) val webServer = new WebServer(myWebServerConfig, routes) webServer.start() }}}

serverName

Human friendly name of this server. Defaults to WebServer.

hostname

Hostname or IP address to bind. 0.0.0.0 will bind to all addresses. You can also specify comma separated hostnames/ip address like localhost,192.168.1.1. Defaults to localhost.

port

IP port number to bind to. Defaults to 8888.

sslConfig

SSL protocol configuration. If None, then SSL will not be turned on. Defaults to None.

httpConfig

HTTP protocol configuration. Default to a and instance of HttpConfig with default settings.

Linear Supertypes
Serializable, Serializable, Product, Equals, Extension, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. WebServerConfig
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Extension
  7. AnyRef
  8. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WebServerConfig (config: Config, prefix: String)

    Read configuration from AKKA's application.conf

  2. new WebServerConfig (serverName: String, hostname: String, port: Int, sslConfig: Option[SslConfig], httpConfig: HttpConfig)

    serverName

    Human friendly name of this server. Defaults to WebServer.

    hostname

    Hostname or IP address to bind. 0.0.0.0 will bind to all addresses. You can also specify comma separated hostnames/ip address like localhost,192.168.1.1. Defaults to localhost.

    port

    IP port number to bind to. Defaults to 8888.

    sslConfig

    SSL protocol configuration. If None, then SSL will not be turned on. Defaults to None.

    httpConfig

    HTTP protocol configuration. Default to a and instance of HttpConfig with default settings.

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 canEqual (arg0: Any): Boolean

    Definition Classes
    WebServerConfig → Equals

  8. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  9. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  10. def equals (arg0: Any): Boolean

    Definition Classes
    WebServerConfig → Equals → 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
    WebServerConfig → AnyRef → Any

  14. val hostname : String

    Hostname or IP address to bind.

    Hostname or IP address to bind. 0.0.0.0 will bind to all addresses. You can also specify comma separated hostnames/ip address like localhost,192.168.1.1. Defaults to localhost.

  15. val httpConfig : HttpConfig

    HTTP protocol configuration.

    HTTP protocol configuration. Default to a and instance of HttpConfig with default settings.

  16. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any

  17. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  18. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  19. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  20. val port : Int

    IP port number to bind to.

    IP port number to bind to. Defaults to 8888.

  21. def productArity : Int

    Definition Classes
    WebServerConfig → Product

  22. def productElement (arg0: Int): Any

    Definition Classes
    WebServerConfig → Product

  23. def productIterator : Iterator[Any]

    Definition Classes
    Product

  24. def productPrefix : String

    Definition Classes
    WebServerConfig → Product

  25. val serverName : String

    Human friendly name of this server.

    Human friendly name of this server. Defaults to WebServer.

  26. val sslConfig : Option[SslConfig]

    SSL protocol configuration.

    SSL protocol configuration. If None, then SSL will not be turned on. Defaults to None.

  27. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef

  28. def toString (): String

    Definition Classes
    WebServerConfig → AnyRef → Any

  29. def validate (): Unit

    Validate current configuration settings.

    Validate current configuration settings. Throws an exception if configuration has errors.

  30. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  31. def wait (arg0: Long, arg1: Int): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  32. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

Deprecated Value Members

  1. def productElements : Iterator[Any]

    Definition Classes
    Product
    Annotations
    @deprecated
    Deprecated

    use productIterator instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Extension

Inherited from AnyRef

Inherited from Any