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

Class StreamingProtocol

java.lang.Object

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

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

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

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

All Implemented Interfaces:

TcpProtocol

@XmlHints(allowTopLevelDefinition=true)
public class StreamingProtocol
extends EOFProtocol

This protocol is an application level TcpProtocol that wraps an InputStream and does not consume it. This allows the SocketOperations#send(RequesterConnection, RequesterConfig, Object, String, String, Message) to return a Message with the original InputStream as payload.

Since:

4.0

Field Summary

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

bufferSize, 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
StreamingProtocol()

Method Summary

Modifier and Type	Method and Description
InputStream	read(InputStream is) Reads the input stream and returns a whole message.
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.EOFProtocol

isRepeat

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

consume, remaining

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

Constructor Detail

StreamingProtocol

public StreamingProtocol()

Method Detail

read

public InputStream read(InputStream is)
                 throws IOException

Reads the input stream and returns a whole message.

Specified by:

read in interface TcpProtocol

Overrides:

read in class DirectProtocol

Parameters:

is - the input stream

Returns:

an InputStream containing a full message

Throws:

IOException - if an exception occurs

write

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

Description copied from interface: TcpProtocol

Write the specified message into the OutputStream.

Specified by:

write in interface TcpProtocol

Overrides:

write in class DirectProtocol

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