org.mule.extension.socket.api.client

Interface SocketClient

All Known Implementing Classes:

TcpClient, UdpClient

public interface SocketClient

Interface for common operations that can be done using a socket.

Since:

4.0

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)

Method Detail

write

void write(Object data,
           String outputEncoding)
    throws IOException

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

InputStream read()
          throws IOException

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

Returns:

an InputStream with the information read from the socket.

Throws:

IOException

close

void close()
    throws IOException

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

Throws:

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

getAttributes

SocketAttributes getAttributes()

Returns:

SocketAttributes with information associated to the client's connection.