Packages

abstract class WebSocketSettings extends javadsl.settings.WebSocketSettings

Self Type
WebSocketSettingsImpl
Annotations
@DoNotInherit()
Source
WebSocketSettings.scala
Linear Supertypes
javadsl.settings.WebSocketSettings, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WebSocketSettings
  2. WebSocketSettings
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new WebSocketSettings()

Abstract Value Members

  1. abstract def logFrames: Boolean
    Definition Classes
    WebSocketSettings → WebSocketSettings
  2. abstract def periodicKeepAliveData: () => ByteString

    The provided function will be invoked for each new keep-alive frame that is sent.

    The provided function will be invoked for each new keep-alive frame that is sent. The ByteString will be included in the Ping or Pong frame sent as heartbeat, so keep in mind to keep it relatively small, in order not to make the frames too bloated.

  3. abstract def periodicKeepAliveMaxIdle: Duration
    Definition Classes
    WebSocketSettings → WebSocketSettings
  4. abstract def periodicKeepAliveMode: String
    Definition Classes
    WebSocketSettings → WebSocketSettings
  5. abstract def randomFactory: () => Random

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from WebSocketSettings toany2stringadd[WebSocketSettings] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (WebSocketSettings, B)
    Implicit
    This member is added by an implicit conversion from WebSocketSettings toArrowAssoc[WebSocketSettings] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def ensuring(cond: (WebSocketSettings) => Boolean, msg: => Any): WebSocketSettings
    Implicit
    This member is added by an implicit conversion from WebSocketSettings toEnsuring[WebSocketSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (WebSocketSettings) => Boolean): WebSocketSettings
    Implicit
    This member is added by an implicit conversion from WebSocketSettings toEnsuring[WebSocketSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): WebSocketSettings
    Implicit
    This member is added by an implicit conversion from WebSocketSettings toEnsuring[WebSocketSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): WebSocketSettings
    Implicit
    This member is added by an implicit conversion from WebSocketSettings toEnsuring[WebSocketSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. final def getPeriodicKeepAliveData: Supplier[ByteString]

    The provided supplier will be invoked for each new keep-alive frame that is sent.

    The provided supplier will be invoked for each new keep-alive frame that is sent. The ByteString will be included in the Ping or Pong frame sent as heartbeat, so keep in mind to keep it relatively small, in order not to make the frames too bloated.

    Definition Classes
    WebSocketSettings → WebSocketSettings
  17. final val getRandomFactory: Supplier[Random]
    Definition Classes
    WebSocketSettings → WebSocketSettings
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  28. def withLogFrames(shouldLog: Boolean): WebSocketSettings
    Definition Classes
    WebSocketSettings → WebSocketSettings
  29. def withPeriodicKeepAliveData(newValue: () => ByteString): WebSocketSettings
  30. def withPeriodicKeepAliveData(newValue: Supplier[ByteString]): javadsl.settings.WebSocketSettings
    Definition Classes
    WebSocketSettings
  31. def withPeriodicKeepAliveMaxIdle(newValue: Duration): WebSocketSettings
    Definition Classes
    WebSocketSettings → WebSocketSettings
  32. def withPeriodicKeepAliveMode(newValue: String): WebSocketSettings
    Definition Classes
    WebSocketSettings → WebSocketSettings
  33. def withRandomFactoryFactory(newValue: Supplier[Random]): WebSocketSettings
    Definition Classes
    WebSocketSettings → WebSocketSettings

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from WebSocketSettings toStringFormat[WebSocketSettings] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def →[B](y: B): (WebSocketSettings, B)
    Implicit
    This member is added by an implicit conversion from WebSocketSettings toArrowAssoc[WebSocketSettings] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from javadsl.settings.WebSocketSettings

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromWebSocketSettings to any2stringadd[WebSocketSettings]

Inherited by implicit conversion StringFormat fromWebSocketSettings to StringFormat[WebSocketSettings]

Inherited by implicit conversion Ensuring fromWebSocketSettings to Ensuring[WebSocketSettings]

Inherited by implicit conversion ArrowAssoc fromWebSocketSettings to ArrowAssoc[WebSocketSettings]

Ungrouped