org.apache.pekko.http.scaladsl.testkit

Interface WSProbe

public interface WSProbe

A WSProbe is a probe that implements a Flow[Message, Message, Unit] for testing websocket code.

Requesting elements is handled automatically.

Method Summary

Modifier and Type	Method and Description
void	expectCompletion() Expect completion on the input side of the flow.
Message	expectMessage() Expect a message on the input side of the flow.
void	expectMessage(org.apache.pekko.util.ByteString bytes) Expect a binary message on the input side of the flow and compares its payload with the given one.
void	expectMessage(java.lang.String text) Expect a text message on the input side of the flow and compares its payload with the given one.
void	expectNoMessage() Expect no message on the input side of the flow.
void	expectNoMessage(scala.concurrent.duration.FiniteDuration max) Expect no message on the input side of the flow for the given maximum duration.
org.apache.pekko.stream.scaladsl.Flow<Message,Message,org.apache.pekko.NotUsed>	flow()
org.apache.pekko.stream.testkit.TestSubscriber.Probe<Message>	inProbe() The underlying probe for the ingoing side of this probe.
org.apache.pekko.stream.testkit.TestPublisher.Probe<Message>	outProbe() The underlying probe for the outgoing side of this probe.
void	sendCompletion() Complete the output side of the flow.
void	sendMessage(org.apache.pekko.util.ByteString bytes) Send a binary message containing the given bytes out of the flow.
void	sendMessage(Message message) Send the given messages out of the flow.
void	sendMessage(java.lang.String text) Send a text message containing the given string out of the flow.

Method Detail

flow

org.apache.pekko.stream.scaladsl.Flow<Message,Message,org.apache.pekko.NotUsed> flow()

sendMessage

void sendMessage(Message message)

Send the given messages out of the flow.

Parameters:

message - (undocumented)

sendMessage

void sendMessage(java.lang.String text)

Send a text message containing the given string out of the flow.

Parameters:

text - (undocumented)

sendMessage

void sendMessage(org.apache.pekko.util.ByteString bytes)

Send a binary message containing the given bytes out of the flow.

Parameters:

bytes - (undocumented)

sendCompletion

void sendCompletion()

Complete the output side of the flow.

expectMessage

Message expectMessage()

Expect a message on the input side of the flow.

Returns:

(undocumented)

expectMessage

void expectMessage(java.lang.String text)

Expect a text message on the input side of the flow and compares its payload with the given one. If the received message is streamed its contents are collected and then asserted against the given String.

Parameters:

text - (undocumented)

expectMessage

void expectMessage(org.apache.pekko.util.ByteString bytes)

Expect a binary message on the input side of the flow and compares its payload with the given one. If the received message is streamed its contents are collected and then asserted against the given ByteString.

Parameters:

bytes - (undocumented)

expectNoMessage

void expectNoMessage()

Expect no message on the input side of the flow.

expectNoMessage

void expectNoMessage(scala.concurrent.duration.FiniteDuration max)

Expect no message on the input side of the flow for the given maximum duration.

Parameters:

max - (undocumented)

expectCompletion

void expectCompletion()

Expect completion on the input side of the flow.

inProbe

org.apache.pekko.stream.testkit.TestSubscriber.Probe<Message> inProbe()

The underlying probe for the ingoing side of this probe. Can be used if the methods on WSProbe don't allow fine enough control over the message flow.

Returns:

(undocumented)

outProbe

org.apache.pekko.stream.testkit.TestPublisher.Probe<Message> outProbe()

The underlying probe for the outgoing side of this probe. Can be used if the methods on WSProbe don't allow fine enough control over the message flow.

Returns:

(undocumented)