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
org.mule.runtime.extension.api.runtime.operation.Result<?,?>	send(RequesterConnection connection, RequesterConfig config, Object content, String outputEncoding, boolean hasResponse, org.mule.runtime.api.message.Message muleMessage) Sends the data using the client associated to the RequesterConnection.

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

send

@OutputResolver(output=SocketMetadataResolver.class)
public org.mule.runtime.extension.api.runtime.operation.Result<?,?> 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,
                                                                                                                              @MetadataKeyId
                                                                                                                              boolean hasResponse,
                                                                                                                              org.mule.runtime.api.message.Message muleMessage)
                                                                                                                       throws org.mule.runtime.api.connection.ConnectionException,
                                                                                                                              IOException

Sends the data using the client associated to the RequesterConnection.

If hasResponse is set, the operation blocks until a response is received or the timeout is met, in which case the operation will return a Message with null payload.

Parameters:

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

hasResponse - whether the operation should await for a response or not

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

muleMessage - if there is no response expected, the outcome of the operation will be the same Message as the input.

Throws:

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

IOException