abstract class WebSocketSettings extends javadsl.settings.WebSocketSettings
- Self Type
- WebSocketSettingsImpl
- Annotations
- @DoNotInherit()
- Source
- WebSocketSettings.scala
Linear Supertypes
Type Hierarchy
Ordering
- Alphabetic
- By Inheritance
Inherited
- WebSocketSettings
- WebSocketSettings
- AnyRef
- Any
Implicitly
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
- new WebSocketSettings()
Abstract Value Members
- abstract def logFrames: Boolean
- Definition Classes
- WebSocketSettings → WebSocketSettings
- 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.
- abstract def periodicKeepAliveMaxIdle: Duration
- Definition Classes
- WebSocketSettings → WebSocketSettings
- abstract def periodicKeepAliveMode: String
- Definition Classes
- WebSocketSettings → WebSocketSettings
- abstract def randomFactory: () => Random
- abstract def receiveIdleTimeout: Duration
- Definition Classes
- WebSocketSettings → WebSocketSettings
- abstract def sendIdleTimeout: Duration
- Definition Classes
- WebSocketSettings → WebSocketSettings
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- 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
- 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()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- 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
- 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
- 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
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- 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
- final val getRandomFactory: Supplier[Random]
- Definition Classes
- WebSocketSettings → WebSocketSettings
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withLogFrames(shouldLog: Boolean): WebSocketSettings
- Definition Classes
- WebSocketSettings → WebSocketSettings
- def withPeriodicKeepAliveData(newValue: () => ByteString): WebSocketSettings
- def withPeriodicKeepAliveData(newValue: Supplier[ByteString]): javadsl.settings.WebSocketSettings
- Definition Classes
- WebSocketSettings
- def withPeriodicKeepAliveMaxIdle(newValue: Duration): WebSocketSettings
- Definition Classes
- WebSocketSettings → WebSocketSettings
- def withPeriodicKeepAliveMode(newValue: String): WebSocketSettings
- Definition Classes
- WebSocketSettings → WebSocketSettings
- def withRandomFactoryFactory(newValue: Supplier[Random]): WebSocketSettings
- Definition Classes
- WebSocketSettings → WebSocketSettings
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- 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 ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- 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.