Class/Object

io.backchat.hookup

ServerInfo

Related Docs: object ServerInfo | package hookup

Permalink

case class ServerInfo(name: String = ServerInfo.DefaultServerName, version: String = BuildInfo.version, listenOn: String = "0.0.0.0", port: Int = 8765, defaultProtocol: String = DefaultProtocol, capabilities: Seq[ServerCapability] = Seq.empty, executionContext: ExecutionContext = HookupClient.executionContext) extends Product with Serializable

Main configuration object for a server

name

The name of this server, defaults to BackchatWebSocketServer

version

The version of the server

listenOn

Which address the server should listen on

port

The port the server should listen on

defaultProtocol

The default protocol for this server to use when no subprotocols have been specified

capabilities

A sequence of io.backchat.hookup.ServerCapability configurations for this server

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

Instance Constructors

  1. new ServerInfo(name: String = ServerInfo.DefaultServerName, version: String = BuildInfo.version, listenOn: String = "0.0.0.0", port: Int = 8765, defaultProtocol: String = DefaultProtocol, capabilities: Seq[ServerCapability] = Seq.empty, executionContext: ExecutionContext = HookupClient.executionContext)

    Permalink

    name

    The name of this server, defaults to BackchatWebSocketServer

    version

    The version of the server

    listenOn

    Which address the server should listen on

    port

    The port the server should listen on

    defaultProtocol

    The default protocol for this server to use when no subprotocols have been specified

    capabilities

    A sequence of io.backchat.hookup.ServerCapability configurations for this server

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. val capabilities: Seq[ServerCapability]

    Permalink

    A sequence of io.backchat.hookup.ServerCapability configurations for this server

  6. def clone(): AnyRef

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

  7. val contentCompression: Option[ContentCompression]

    Permalink

    If the server should support content compression this will have the configuration for it.

  8. val defaultProtocol: String

    Permalink

    The default protocol for this server to use when no subprotocols have been specified

  9. val defaultWireFormat: WireFormat

    Permalink

  10. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  11. val executionContext: ExecutionContext

    Permalink

  12. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  13. val flashPolicy: String

    Permalink

    The configuration for the flash policy, by default it allows all..

  14. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  16. val listenOn: String

    Permalink

    Which address the server should listen on

  17. val maxFrameSize: Long

    Permalink

    If the server should support max frame sizes for websocket frames this will have the configuration for it.

  18. val name: String

    Permalink

    The name of this server, defaults to BackchatWebSocketServer

  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. val pingTimeout: Option[Timeout]

    Permalink

    If the server should support pinging this will have the configuration for it.

  23. val port: Int

    Permalink

    The port the server should listen on

  24. val protocols: Seq[WireFormat]

    Permalink

    If the server should support sub-protocols this will have the configuration for it.

  25. val sslContext: Option[SSLContext]

    Permalink

    If the server should support SSL this will be filled with the ssl context to use

  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  27. val version: String

    Permalink

    The version of the server

  28. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  30. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped