org.mule.extension.socket.api.socket.tcp

Interface TcpProtocol

All Known Implementing Classes:

AbstractByteProtocol, CustomClassLoadingLengthProtocol, CustomProtocol, DirectProtocol, EOFProtocol, LengthProtocol, SafeProtocol, StreamingProtocol, XmlMessageEOFProtocol, XmlMessageProtocol

public interface TcpProtocol

This interface enables to plug different application level protocols into the SocketsExtension.

Since:

4.0

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.

Method Detail

read

InputStream read(InputStream is)
          throws IOException

Reads the input stream and returns a whole message.

Parameters:

is - the input stream

Returns:

an InputStream containing a full message

Throws:

IOException - if an exception occurs

write

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

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