org.mule.extension.socket.api

Class SocketOperations

java.lang.Object

org.mule.extension.socket.api.SocketOperations

public class SocketOperations
extends Object

Basic set of operations for socket extension

Since:

4.0

Constructor Summary

Constructors

Constructor and Description
SocketOperations()

Method Summary

Modifier and Type	Method and Description
void	send(RequesterConnection connection, RequesterConfig config, Object content, String outputEncoding) Sends the data using the client associated to the RequesterConnection.
org.mule.runtime.extension.api.runtime.operation.Result<InputStream,SocketAttributes>	sendAndReceive(RequesterConnection connection, RequesterConfig config, Object content, String outputEncoding) Sends the data using the client associated to the RequesterConnection and then blocks until a response is received or the timeout is met, in which case the operation will return a null payload.

Methods inherited from class java.lang.Object

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

Constructor Detail

SocketOperations

public SocketOperations()

Method Detail

sendAndReceive

public org.mule.runtime.extension.api.runtime.operation.Result<InputStream,SocketAttributes> sendAndReceive(@Connection
                                                                                                            RequesterConnection connection,
                                                                                                            @UseConfig
                                                                                                            RequesterConfig config,
                                                                                                            @Content
                                                                                                            Object content,
                                                                                                            @Optional @Summary(value="Encoding to use when the data to serialize is of String type")
                                                                                                            String outputEncoding)
                                                                                                     throws org.mule.runtime.api.connection.ConnectionException,
                                                                                                            IOException

Sends the data using the client associated to the RequesterConnection and then blocks until a response is received or the timeout is met, in which case the operation will return a null payload.

Parameters:

content - data that will be serialized and sent through the socket.

outputEncoding - encoding that will be used to serialize the data if its type is String.

Throws:

org.mule.runtime.api.connection.ConnectionException - if the connection couldn't be established, if the remote host was unavailable.

IOException

send

public void send(@Connection
                 RequesterConnection connection,
                 @UseConfig
                 RequesterConfig config,
                 @Content
                 Object content,
                 @Optional @Summary(value="Encoding to use when the data to serialize is of String type")
                 String outputEncoding)
          throws org.mule.runtime.api.connection.ConnectionException,
                 IOException

Sends the data using the client associated to the RequesterConnection.

Parameters:

content - data that will be serialized and sent through the socket.

outputEncoding - encoding that will be used to serialize the data if its type is String.

Throws:

org.mule.runtime.api.connection.ConnectionException - if the connection couldn't be established, if the remote host was unavailable.

IOException