org.mule.extension.socket.api.connection.tcp.protocol

Class DirectProtocol

java.lang.Object

org.mule.extension.socket.api.connection.tcp.protocol.AbstractByteProtocol

org.mule.extension.socket.api.connection.tcp.protocol.DirectProtocol

All Implemented Interfaces:

TcpProtocol

Direct Known Subclasses:

EOFProtocol, LengthProtocol

@XmlHints(allowTopLevelDefinition=true)
public class DirectProtocol
extends AbstractByteProtocol

This protocol is an application level TcpProtocol that does nothing. The socket reads until no more bytes are (momentarily) available (previously the transfer buffer also had to be full on the previous read, which made stronger requirements on the underlying network). On slow networks EOFProtocol and LengthProtocol may be more reliable.

Writing simply writes the data into the socket.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
protected int	bufferSize
protected static int	UNLIMITED

Fields inherited from class org.mule.extension.socket.api.connection.tcp.protocol.AbstractByteProtocol

EOF, NO_MAX_LENGTH, NO_STREAM, objectSerializer, rethrowExceptionOnRead, STREAM_OK, streamOk

Constructor Summary

Constructors

Constructor and Description
DirectProtocol()
DirectProtocol(boolean streamOk, int bufferSize)

Method Summary

Modifier and Type	Method and Description
protected byte[]	consume(InputStream is, int limit)
protected boolean	isRepeat(int len, int available) Decide whether to repeat transfer.
InputStream	read(InputStream socketIs) Reads the input stream and returns a whole message.
protected int	remaining(int limit, int remain, int len)
void	write(OutputStream os, Object data, String encoding) Write the specified message into the OutputStream.

Methods inherited from class org.mule.extension.socket.api.connection.tcp.protocol.AbstractByteProtocol

copy, copy, nullIfEmptyArray, safeRead, safeRead, setObjectSerializer, writeByteArray

Methods inherited from class java.lang.Object

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

Field Detail

UNLIMITED

protected static final int UNLIMITED

See Also:

Constant Field Values

bufferSize

protected int bufferSize

Constructor Detail

DirectProtocol

public DirectProtocol()

DirectProtocol

public DirectProtocol(boolean streamOk,
                      int bufferSize)

Method Detail

read

public InputStream read(InputStream socketIs)
                 throws IOException

Reads the input stream and returns a whole message.

Parameters:

socketIs - the input stream

Returns:

an InputStream containing a full message

Throws:

IOException - if an exception occurs

consume

protected byte[] consume(InputStream is,
                         int limit)
                  throws IOException

Throws:

IOException

remaining

protected int remaining(int limit,
                        int remain,
                        int len)

isRepeat

protected boolean isRepeat(int len,
                           int available)

Decide whether to repeat transfer. This implementation does so if more data are available. Note that previously, while documented as such, there was also the additional requirement that the previous transfer completely used the transfer buffer.

Parameters:

len - Amount transferred last call (-1 on EOF or socket error)

available - Amount available

Returns:

true if the transfer should continue

write

public void write(OutputStream os,
                  Object data,
                  String encoding)
           throws IOException

Description copied from interface: TcpProtocol

Write the specified message into the OutputStream.

Parameters:

os - the OutputStream in which the data is going to be written

data - data to be written

encoding - in which the data will be serialized if its type is String

Throws:

IOException - if an exception occurs