org.perfcake.message.sender

Class ChannelSender

java.lang.Object

org.perfcake.message.sender.AbstractSender

org.perfcake.message.sender.ChannelSender

All Implemented Interfaces:

MessageSender

Direct Known Subclasses:

ChannelSenderDatagram, ChannelSenderFile, ChannelSenderSocket

public abstract class ChannelSender
extends AbstractSender

Common ancestor to all sender's sending messages through NIO channels.

Author:

Dominik Hanák, Martin Večeřa

Constructor Summary

Constructors

Constructor and Description
ChannelSender()

Method Summary

Modifier and Type	Method and Description
void	doClose()
boolean	getAwaitResponse() Gets the status of waiting for response on the channel.
int	getMaxResponseSize() Gets the expected response maximum size.
void	postSend(Message message) Performs any action that needs to be done to complete the sending of the message but is not directly related to the sending operation and thus not measured.
void	preSend(Message message, Properties messageAttributes) Performs any action that needs to be done to send the message but is not directly related to the sending operation and thus not measured.
ChannelSender	setAwaitResponse(boolean awaitResponse) Specifies whether to wait for a response.
ChannelSender	setMaxResponseSize(int maxResponseSize) Sets the expected response maximum size.

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

close, doInit, doSend, getTarget, getTarget, init, isKeepConnection, safeGetTarget, send, setKeepConnection, setTarget

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelSender

public ChannelSender()

Method Detail

doClose

public void doClose()
             throws PerfCakeException

Specified by:

doClose in class AbstractSender

Throws:

PerfCakeException

preSend

public void preSend(Message message,
                    Properties messageAttributes)
             throws Exception

Description copied from interface: MessageSender

Performs any action that needs to be done to send the message but is not directly related to the sending operation and thus not measured.

Specified by:

preSend in interface MessageSender

Overrides:

preSend in class AbstractSender

Parameters:

message - Message to be sent.

messageAttributes - Attributes that can be used to replace placeholders in message and or target.

Throws:

Exception - In case anything fails during the preparation.

postSend

public void postSend(Message message)
              throws Exception

Description copied from interface: MessageSender

Performs any action that needs to be done to complete the sending of the message but is not directly related to the sending operation and thus not measured.

Specified by:

postSend in interface MessageSender

Overrides:

postSend in class AbstractSender

Parameters:

message - Message that was sent.

Throws:

Exception - In case anything fails during the finalization.

getAwaitResponse

public boolean getAwaitResponse()

Gets the status of waiting for response on the channel.

Returns:

True if and only if the sender awaits response.

setAwaitResponse

public ChannelSender setAwaitResponse(boolean awaitResponse)

Specifies whether to wait for a response.

Parameters:

awaitResponse - True to make the sender to wait for a response.

Returns:

Instance of this to support fluent API.

getMaxResponseSize

public int getMaxResponseSize()

Gets the expected response maximum size. If set to -1, the response buffer will have the same size as the original message.

Returns:

The maximum configured buffer size.

setMaxResponseSize

public ChannelSender setMaxResponseSize(int maxResponseSize)

Sets the expected response maximum size. Set to -1 for the response buffer to have the same size as the original message.

Parameters:

maxResponseSize - The desired maximum response size.

Returns:

Instance of this to support fluent API.