org.perfcake.message.sender

Class WebSocketSender

java.lang.Object

org.perfcake.message.sender.AbstractSender

org.perfcake.message.sender.WebSocketSender

All Implemented Interfaces:

MessageSender

public class WebSocketSender
extends AbstractSender

Sends a simple messages via websocket protocol to a remote websocket server endpoint.

Author:

Jiří Sviták

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebSocketSender.PayloadType Payload type.
class	WebSocketSender.PerfCakeClientEndpoint Represents web socket client endpoint.
static class	WebSocketSender.RemoteEndpointType Remote endpoint type.

Constructor Summary

Constructors

Constructor and Description
WebSocketSender()

Method Summary

Modifier and Type	Method and Description
void	doClose()
void	doInit(Properties messageAttributes)
Serializable	doSend(Message message, MeasurementUnit measurementUnit) Actually performs the send operation.
WebSocketSender.PayloadType	getPayloadType() Returns payload type.
WebSocketSender.RemoteEndpointType	getRemoteEndpointType() Returns remote endpoint type.
WebSocketSender	setPayloadType(WebSocketSender.PayloadType payloadType) Sets payload type.
WebSocketSender	setRemoteEndpointType(WebSocketSender.RemoteEndpointType remoteEndpointType) Sets remote endpoint type.

Methods inherited from class org.perfcake.message.sender.AbstractSender

close, getTarget, getTarget, init, isKeepConnection, postSend, preSend, safeGetTarget, send, setKeepConnection, setTarget

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebSocketSender

public WebSocketSender()

Method Detail

setRemoteEndpointType

public WebSocketSender setRemoteEndpointType(WebSocketSender.RemoteEndpointType remoteEndpointType)

Sets remote endpoint type.

Parameters:

remoteEndpointType - The remote endpoint type. The value should be one of basic or async.

Returns:

Instance of this to support fluent API.

getRemoteEndpointType

public WebSocketSender.RemoteEndpointType getRemoteEndpointType()

Returns remote endpoint type.

Returns:

One of basic or async.

setPayloadType

public WebSocketSender setPayloadType(WebSocketSender.PayloadType payloadType)

Sets payload type.

Parameters:

payloadType - The payload type. The value should be one of text, binary or ping.

Returns:

Instance of this to support fluent API.

getPayloadType

public WebSocketSender.PayloadType getPayloadType()

Returns payload type.

Returns:

One of text, binary or ping.

doInit

public void doInit(Properties messageAttributes)
            throws PerfCakeException

Specified by:

doInit in class AbstractSender

Throws:

PerfCakeException

doClose

public void doClose()
             throws PerfCakeException

Specified by:

doClose in class AbstractSender

Throws:

PerfCakeException

doSend

public Serializable doSend(Message message,
                           MeasurementUnit measurementUnit)
                    throws Exception

Description copied from class: AbstractSender

Actually performs the send operation. Should be overridden by specific implementations.

Specified by:

doSend in class AbstractSender

Parameters:

message - Message to be sent.

measurementUnit - Measurement unit carrying the current stop-watch.

Returns:

Response to the message.

Throws:

Exception - When the sending operation failed.

See Also:

MessageSender.send(org.perfcake.message.Message, org.perfcake.reporting.MeasurementUnit)