org.mule.extension.socket.api.client

Class TcpClient

java.lang.Object

org.mule.extension.socket.api.client.TcpClient

All Implemented Interfaces:

SocketClient

public final class TcpClient
extends Object
implements SocketClient

This SocketClient implementation allows the reading and writing to and from a specific connected TCP Socket.

Constructor Summary

Constructors

Constructor and Description
TcpClient(Socket socket, TcpProtocol protocol)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection that was held by the client, leaving it unusable.
SocketAttributes	getAttributes()
InputStream	read() This methods blocks until new data is available or SocketProperties.getClientTimeout() is reached, in which case a ReadingTimeoutException is thrown.
void	write(Object data, String outputEncoding)

Methods inherited from class java.lang.Object

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

Constructor Detail

TcpClient

public TcpClient(Socket socket,
                 TcpProtocol protocol)

Method Detail

write

public void write(Object data,
                  String outputEncoding)
           throws IOException

Specified by:

write in interface SocketClient

Parameters:

data - to be written into the socket

outputEncoding - to be used when writing contents of type String. If not specified, it defaults to the encoding specified in the config AbstractSocketConfig. If no default is specified AbstractSocketConfig either, mule's default encoding is used.

Throws:

IOException

read

public InputStream read()
                 throws IOException

This methods blocks until new data is available or SocketProperties.getClientTimeout() is reached, in which case a ReadingTimeoutException is thrown.

Specified by:

read in interface SocketClient

Returns:

an InputStream with the information read from the socket.

Throws:

IOException

close

public void close()
           throws IOException

Closes the connection that was held by the client, leaving it unusable.

Specified by:

close in interface SocketClient

Throws:

IOException - if an I/O error occurs when closing the socket

getAttributes

public SocketAttributes getAttributes()

Specified by:

getAttributes in interface SocketClient

Returns:

SocketAttributes with information associated to the client's connection.