Class/Object

sttp.ws.testing

WebSocketStub

Related Docs: object WebSocketStub | package testing

Permalink

class WebSocketStub[S] extends AnyRef

A stub for websockets that uses a queue of frames which are returned when the client calls WebSocket.receive.

New messages can be added to queue in reaction to WebSocket.send being invoked, by specifying the behavior using one of the thenRespond variants.

For more complex cases, please provide your own implementation of WebSocket.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WebSocketStub
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WebSocketStub(initialResponses: List[Try[WebSocketFrame]], initialState: S, makeNewResponses: (S, WebSocketFrame) ⇒ (S, List[Try[WebSocketFrame]]))

    Permalink

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. def build[F[_]](implicit m: MonadError[F]): WebSocket[F]

    Permalink

  6. def clone(): AnyRef

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

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

    Permalink
    Definition Classes
    AnyRef

  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

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

    Permalink
    Definition Classes
    AnyRef

  16. def thenRespond(addReceived: (WebSocketFrame) ⇒ List[WebSocketFrame]): WebSocketStub[Unit]

    Permalink

    Creates a stub that has the same initial receive frames, but replaces the function that adds responses to be received in reaction to WebSocket.send being invoked.

  17. def thenRespondS[S2](initial: S2)(onSend: (S2, WebSocketFrame) ⇒ (S2, List[WebSocketFrame])): WebSocketStub[S2]

    Permalink

    Creates a stub that has the same initial responses, but replaces the function that adds responses to be received in reaction to WebSocket.send being invoked.

    Creates a stub that has the same initial responses, but replaces the function that adds responses to be received in reaction to WebSocket.send being invoked.

    More powerful version of thenRespond(), as the given function can additionally use state and implement stateful logic for computing response messages.

  18. def thenRespondWith(addReceived: (WebSocketFrame) ⇒ List[Try[WebSocketFrame]]): WebSocketStub[Unit]

    Permalink

    Creates a stub that has the same initial receive frames, but replaces the function that adds responses to be received in reaction to WebSocket.send being invoked.

    Creates a stub that has the same initial receive frames, but replaces the function that adds responses to be received in reaction to WebSocket.send being invoked.

    More powerful version of thenRespond() which allows receiving to fail with an exception.

  19. def thenRespondWithS[S2](initial: S2)(onSend: (S2, WebSocketFrame) ⇒ (S2, List[Try[WebSocketFrame]])): WebSocketStub[S2]

    Permalink

    Creates a stub that has the same initial responses, but replaces the function that adds responses to be received in reaction to WebSocket.send being invoked.

    Creates a stub that has the same initial responses, but replaces the function that adds responses to be received in reaction to WebSocket.send being invoked.

    More powerful version of: - thenRespond(), as the given function can additionally use state and implement stateful logic for computing response messages. - thenRespondS() which allows receiving to fail with an exception.

  20. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

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

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

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

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

  23. final def wait(): Unit

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

Deprecated Value Members

  1. def finalize(): Unit

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

    (Since version ) see corresponding Javadoc for more information.

Inherited from AnyRef

Inherited from Any

Ungrouped