Skip navigation links
A B C D E F G H I K L N O R S T U V W X 

A

AbstractByteProtocol - Class in org.mule.extension.socket.api.connection.tcp.protocol
This Abstract class has been introduced so as to have the byte protocols (i.e.
AbstractByteProtocol(boolean) - Constructor for class org.mule.extension.socket.api.connection.tcp.protocol.AbstractByteProtocol
 
AbstractSocketConfig - Class in org.mule.extension.socket.api.config
Abstract config for SocketsExtension
AbstractSocketConfig() - Constructor for class org.mule.extension.socket.api.config.AbstractSocketConfig
 
AbstractSocketConnection - Class in org.mule.extension.socket.api.connection
Contains common configuration parameters to all the kinds of SocketConnection
AbstractSocketConnection(SocketConnectionSettings) - Constructor for class org.mule.extension.socket.api.connection.AbstractSocketConnection
 
AbstractSocketProperties - Class in org.mule.extension.socket.api.socket
Configuration fields common to all socket implementations
AbstractSocketProperties() - Constructor for class org.mule.extension.socket.api.socket.AbstractSocketProperties
 
AbstractTcpSocketProperties - Class in org.mule.extension.socket.api.socket.tcp
Common configuration fields for TCP Socket
AbstractTcpSocketProperties() - Constructor for class org.mule.extension.socket.api.socket.tcp.AbstractTcpSocketProperties
 
AbstractUdpConnection - Class in org.mule.extension.socket.api.connection.udp
Provides fields and behaviour common to UDP connections
AbstractUdpConnection(SocketConnectionSettings, UdpSocketProperties) - Constructor for class org.mule.extension.socket.api.connection.udp.AbstractUdpConnection
 

B

broadcast - Variable in class org.mule.extension.socket.api.socket.udp.UdpSocketProperties
Enable/disable SO_BROADCAST into the DatagramSocket
bufferSize - Variable in class org.mule.extension.socket.api.connection.tcp.protocol.DirectProtocol
 

C

callback - Variable in class org.mule.extension.socket.api.worker.SocketWorker
 
clazz - Variable in class org.mule.extension.socket.api.connection.tcp.protocol.CustomProtocol
Reference to full qualifier class name that should extend TcpProtocol that will be used as a custom protocol
clientTimeout - Variable in class org.mule.extension.socket.api.socket.AbstractSocketProperties
This sets the SO_TIMEOUT value on sockets.
close() - Method in interface org.mule.extension.socket.api.client.SocketClient
Closes the connection that was held by the client, leaving it unusable.
close() - Method in class org.mule.extension.socket.api.client.TcpClient
Closes the connection that was held by the client, leaving it unusable.
close() - Method in class org.mule.extension.socket.api.client.UdpClient
Closes the connection that was held by the client, leaving it unusable.
configureConnection(DatagramSocket, UdpSocketProperties) - Static method in class org.mule.extension.socket.internal.SocketUtils
Sets the configuration parameters into the socket.
configureConnection(Socket, TcpSocketProperties) - Static method in class org.mule.extension.socket.internal.SocketUtils
Sets the configuration parameters into the socket
connect() - Method in interface org.mule.extension.socket.api.connection.SocketConnection
Establish a connection ready to be used.
connect() - Method in class org.mule.extension.socket.api.connection.tcp.TcpListenerConnection
Configures the ServerSocket instance with the TcpServerSocketProperties parameters.
connect() - Method in class org.mule.extension.socket.api.connection.tcp.TcpRequesterConnection
Establish a connection ready to be used.
connect() - Method in class org.mule.extension.socket.api.connection.udp.UdpListenerConnection
 
connect() - Method in class org.mule.extension.socket.api.connection.udp.UdpRequesterConnection
Configures a DatagramSocket with the settings provided in the UdpSocketProperties and bounded to the connection settings presents on localAddressSettings.
connect() - Method in class org.mule.extension.socket.api.provider.tcp.TcpListenerProvider
 
connect() - Method in class org.mule.extension.socket.api.provider.tcp.TcpRequesterProvider
connect() - Method in class org.mule.extension.socket.api.provider.udp.UdpListenerProvider
 
connect() - Method in class org.mule.extension.socket.api.provider.udp.UdpRequesterProvider
 
connectionSettings - Variable in class org.mule.extension.socket.api.connection.AbstractSocketConnection
 
consume(InputStream, int) - Method in class org.mule.extension.socket.api.connection.tcp.protocol.DirectProtocol
 
COOKIE - Static variable in class org.mule.extension.socket.api.connection.tcp.protocol.SafeProtocol
 
copy(InputStream, byte[], OutputStream) - Method in class org.mule.extension.socket.api.connection.tcp.protocol.AbstractByteProtocol
Make a single transfer from source to dest via a byte array buffer
copy(InputStream, byte[], OutputStream, int) - Method in class org.mule.extension.socket.api.connection.tcp.protocol.AbstractByteProtocol
Make a single transfer from source to dest via a byte array buffer
createPacket(byte[]) - Static method in class org.mule.extension.socket.internal.SocketUtils
Creates a DatagramPacket with the size of the content, addressed to the port and address of the client.
createPacket(int) - Static method in class org.mule.extension.socket.internal.SocketUtils
 
createResult(InputStream, SocketAttributes) - Static method in class org.mule.extension.socket.internal.SocketUtils
 
createServerSocket() - Method in interface org.mule.extension.socket.api.socket.factory.SimpleServerSocketFactory
Creates a ServerSocket
createServerSocket() - Method in class org.mule.extension.socket.api.socket.factory.SslServerSocketFactory
Creates a ServerSocket
createServerSocket() - Method in class org.mule.extension.socket.api.socket.factory.TcpServerSocketFactory
Creates a ServerSocket
createSocket() - Method in interface org.mule.extension.socket.api.socket.factory.SimpleSocketFactory
Creates a Socket
createSocket() - Method in class org.mule.extension.socket.api.socket.factory.SslSocketFactory
Creates a Socket
createSocket() - Method in class org.mule.extension.socket.api.socket.factory.TcpSocketFactory
Creates a Socket
CustomClassLoadingLengthProtocol - Class in org.mule.extension.socket.api.connection.tcp.protocol
A length protocol that uses a specific class loader to load objects from streams
CustomClassLoadingLengthProtocol() - Constructor for class org.mule.extension.socket.api.connection.tcp.protocol.CustomClassLoadingLengthProtocol
 
CustomProtocol - Class in org.mule.extension.socket.api.connection.tcp.protocol
 
CustomProtocol() - Constructor for class org.mule.extension.socket.api.connection.tcp.protocol.CustomProtocol
 

D

DirectProtocol - Class in org.mule.extension.socket.api.connection.tcp.protocol
This protocol is an application level TcpProtocol that does nothing.
DirectProtocol() - Constructor for class org.mule.extension.socket.api.connection.tcp.protocol.DirectProtocol
 
DirectProtocol(boolean, int) - Constructor for class org.mule.extension.socket.api.connection.tcp.protocol.DirectProtocol
 
disconnect() - Method in class org.mule.extension.socket.api.connection.AbstractSocketConnection
 
disconnect() - Method in interface org.mule.extension.socket.api.connection.SocketConnection
Disconnects the connection.
disconnect(TcpListenerConnection) - Method in class org.mule.extension.socket.api.provider.tcp.TcpListenerProvider
disconnect(TcpRequesterConnection) - Method in class org.mule.extension.socket.api.provider.tcp.TcpRequesterProvider
disconnect(UdpListenerConnection) - Method in class org.mule.extension.socket.api.provider.udp.UdpListenerProvider
 
disconnect(UdpRequesterConnection) - Method in class org.mule.extension.socket.api.provider.udp.UdpRequesterProvider
 
dispose() - Method in class org.mule.extension.socket.api.worker.TcpWorker
 
dispose() - Method in class org.mule.extension.socket.api.worker.UdpWorker
 
doDisconnect() - Method in class org.mule.extension.socket.api.connection.AbstractSocketConnection
Template method that does the concrete disconnection for the socket
doDisconnect() - Method in class org.mule.extension.socket.api.connection.tcp.TcpListenerConnection
 
doDisconnect() - Method in class org.mule.extension.socket.api.connection.tcp.TcpRequesterConnection
 
doDisconnect() - Method in class org.mule.extension.socket.api.connection.udp.AbstractUdpConnection
 
doRun() - Method in class org.mule.extension.socket.api.worker.SocketWorker
 
doRun() - Method in class org.mule.extension.socket.api.worker.TcpWorker
 
doRun() - Method in class org.mule.extension.socket.api.worker.UdpWorker
 

E

encoding - Variable in class org.mule.extension.socket.api.worker.SocketWorker
 
EOF - Static variable in class org.mule.extension.socket.api.connection.tcp.protocol.AbstractByteProtocol
 
EOFProtocol - Class in org.mule.extension.socket.api.connection.tcp.protocol
This protocol is an application level TcpProtocol that does nothing.
EOFProtocol() - Constructor for class org.mule.extension.socket.api.connection.tcp.protocol.EOFProtocol
 

F

failOnUnresolvedHost - Variable in class org.mule.extension.socket.api.socket.tcp.AbstractTcpSocketProperties
Whether the socket should fail during its creation if the host set on the endpoint cannot be resolved.

G

getAttributes() - Method in interface org.mule.extension.socket.api.client.SocketClient
 
getAttributes() - Method in class org.mule.extension.socket.api.client.TcpClient
getAttributes() - Method in class org.mule.extension.socket.api.client.UdpClient
getBroadcast() - Method in class org.mule.extension.socket.api.socket.udp.UdpSocketProperties
Whether to enable the socket to write broadcast data
getByteArray(Object, boolean, String, ObjectSerializer) - Static method in class org.mule.extension.socket.internal.SocketUtils
 
getClassLoader() - Method in class org.mule.extension.socket.api.connection.tcp.protocol.CustomClassLoadingLengthProtocol
 
getClient() - Method in interface org.mule.extension.socket.api.connection.RequesterConnection
Returns a new instance of SocketClient particular to this connection.
getClient() - Method in class org.mule.extension.socket.api.connection.tcp.TcpRequesterConnection
Returns a new instance of SocketClient particular to this connection.
getClient() - Method in class org.mule.extension.socket.api.connection.udp.UdpRequesterConnection
Returns a new instance of SocketClient particular to this connection.
getClientTimeout() - Method in class org.mule.extension.socket.api.socket.AbstractSocketProperties
This sets the SO_TIMEOUT value on client sockets.
getClientTimeout() - Method in interface org.mule.extension.socket.api.socket.SocketProperties
This sets the SO_TIMEOUT value on client sockets.
getConnectionTimeout() - Method in class org.mule.extension.socket.api.socket.tcp.TcpClientSocketProperties
Number of milliseconds to wait until an outbound connection to a remote server is successfully created.
getDefaultEncoding() - Method in class org.mule.extension.socket.api.config.AbstractSocketConfig
 
getFailOnUnresolvedHost() - Method in class org.mule.extension.socket.api.socket.tcp.AbstractTcpSocketProperties
Will fail during sending if the remote host address cannot be resolved.
getFailOnUnresolvedHost() - Method in interface org.mule.extension.socket.api.socket.tcp.TcpSocketProperties
Will fail during sending if the remote host address cannot be resolved.
getHost() - Method in class org.mule.extension.socket.api.SocketConnectionSettings
 
getHostAddress() - Method in class org.mule.extension.socket.api.ImmutableSocketAttributes
getHostAddress() - Method in interface org.mule.extension.socket.api.SocketAttributes
 
getHostName() - Method in class org.mule.extension.socket.api.ImmutableSocketAttributes
getHostName() - Method in interface org.mule.extension.socket.api.SocketAttributes
 
getInetSocketAddress() - Method in class org.mule.extension.socket.api.SocketConnectionSettings
If the port is null, let's the system choose a suitable port If the host is null uses the IP address wildcard address.
getKeepAlive() - Method in class org.mule.extension.socket.api.socket.tcp.AbstractTcpSocketProperties
Enables SO_KEEPALIVE behavior on open sockets.
getKeepAlive() - Method in interface org.mule.extension.socket.api.socket.tcp.TcpSocketProperties
Enables SO_KEEPALIVE behavior on open sockets.
getLinger() - Method in class org.mule.extension.socket.api.socket.tcp.AbstractTcpSocketProperties
This sets the SO_LINGER value.
getLinger() - Method in interface org.mule.extension.socket.api.socket.tcp.TcpSocketProperties
This sets the SO_LINGER value.
getLocalAddress() - Method in interface org.mule.extension.socket.api.socket.RequesterSocketProperties
 
getLocalCertificates() - Method in class org.mule.extension.socket.api.ImmutableSocketAttributes
getLocalCertificates() - Method in interface org.mule.extension.socket.api.SocketAttributes
 
getName() - Method in class org.mule.extension.socket.api.socket.AbstractSocketProperties
 
getPeerCertificates() - Method in class org.mule.extension.socket.api.ImmutableSocketAttributes
getPeerCertificates() - Method in interface org.mule.extension.socket.api.SocketAttributes
 
getPort() - Method in class org.mule.extension.socket.api.ImmutableSocketAttributes
getPort() - Method in interface org.mule.extension.socket.api.SocketAttributes
 
getPort() - Method in class org.mule.extension.socket.api.SocketConnectionSettings
 
getReceiveBacklog() - Method in class org.mule.extension.socket.api.socket.tcp.TcpServerSocketProperties
The maximum queue length for incoming connections.
getReceiveBufferSize() - Method in class org.mule.extension.socket.api.socket.AbstractSocketProperties
The size of the buffer (in bytes) used when receiving data, set on the socket itself.
getReceiveBufferSize() - Method in interface org.mule.extension.socket.api.socket.SocketProperties
The size of the buffer (in bytes) used when receiving data, set on the socket itself.
getReceiveBufferSize() - Method in class org.mule.extension.socket.api.socket.udp.UdpSocketProperties
 
getReuseAddress() - Method in class org.mule.extension.socket.api.socket.AbstractSocketProperties
Enabling SO_REUSEADDR prior to binding the socket using bind(SocketAddress) allows the socket to be bound even though a previous connection is in a clientSocketTimeout state.
getReuseAddress() - Method in interface org.mule.extension.socket.api.socket.SocketProperties
Enabling SO_REUSEADDR prior to binding the socket using bind(SocketAddress) allows the socket to be bound even though a previous connection is in a clientSocketTimeout state.
getSendBufferSize() - Method in class org.mule.extension.socket.api.socket.AbstractSocketProperties
The size of the buffer (in bytes) used when sending data, set on the socket itself.
getSendBufferSize() - Method in interface org.mule.extension.socket.api.socket.SocketProperties
The size of the buffer (in bytes) used when sending data, set on the socket itself.
getSendTcpNoDelay() - Method in class org.mule.extension.socket.api.socket.tcp.AbstractTcpSocketProperties
If set, transmitted data is not collected together for greater efficiency but sent immediately.
getSendTcpNoDelay() - Method in interface org.mule.extension.socket.api.socket.tcp.TcpSocketProperties
If set, transmitted data is not collected together for greater efficiency but sent immediately.
getServerTimeout() - Method in class org.mule.extension.socket.api.socket.tcp.TcpServerSocketProperties
Sets the SO_TIMEOUT value when the socket is used as a server.
getUdpAllowedByteArray(Object, String, ObjectSerializer) - Static method in class org.mule.extension.socket.internal.SocketUtils
UDP doesn't allow streaming and it always sends payload when dealing with a Message
GROUP_NAME - Static variable in interface org.mule.extension.socket.api.socket.SocketProperties
 

H

handle(InputStream, SocketAttributes) - Method in class org.mule.extension.socket.api.worker.SocketWorker
 

I

ImmutableSocketAttributes - Class in org.mule.extension.socket.api
Immutable implementation of SocketAttributes.
ImmutableSocketAttributes(Socket) - Constructor for class org.mule.extension.socket.api.ImmutableSocketAttributes
Creates a new instance
ImmutableSocketAttributes(DatagramSocket) - Constructor for class org.mule.extension.socket.api.ImmutableSocketAttributes
Creates a new instance
ImmutableSocketAttributes(DatagramPacket) - Constructor for class org.mule.extension.socket.api.ImmutableSocketAttributes
Creates a new instance
ImmutableSocketAttributes(int, String, String) - Constructor for class org.mule.extension.socket.api.ImmutableSocketAttributes
 
initialise() - Method in class org.mule.extension.socket.api.connection.tcp.protocol.CustomProtocol
 
initialise() - Method in class org.mule.extension.socket.api.provider.tcp.TcpListenerProvider
 
initialise() - Method in class org.mule.extension.socket.api.provider.tcp.TcpRequesterProvider
 
isRepeat(int, int) - Method in class org.mule.extension.socket.api.connection.tcp.protocol.DirectProtocol
Decide whether to repeat transfer.
isRepeat(int, int) - Method in class org.mule.extension.socket.api.connection.tcp.protocol.EOFProtocol
Repeat until EOF
isRepeat(int, int) - Method in class org.mule.extension.socket.api.connection.tcp.protocol.LengthProtocol
Read all four bytes for initial integer (limit is set in read)
isRepeat(int, int, int) - Method in class org.mule.extension.socket.api.connection.tcp.protocol.XmlMessageEOFProtocol
Continue reading til EOF or new document found
isRepeat(int, int, int) - Method in class org.mule.extension.socket.api.connection.tcp.protocol.XmlMessageProtocol
Show we continue reading? This class, following previous implementations, only reads while input is saturated.
isStreaming() - Method in class org.mule.extension.socket.internal.TcpInputStream
 

K

keepAlive - Variable in class org.mule.extension.socket.api.socket.tcp.AbstractTcpSocketProperties
Enables SO_KEEPALIVE behavior on open sockets.

L

LENGTH_EXCEEDED - Static variable in class org.mule.extension.socket.api.connection.tcp.protocol.LengthProtocol
 
LengthExceededException - Exception in org.mule.extension.socket.api.exceptions
Thrown to indicate that there was an attempt of reading or writing more bytes that the allowed limit.
LengthExceededException(String) - Constructor for exception org.mule.extension.socket.api.exceptions.LengthExceededException
 
LengthProtocol - Class in org.mule.extension.socket.api.connection.tcp.protocol
This protocol is an application level TcpProtocol that can be used to transfer large amounts of data without risking some data to be loss.
LengthProtocol() - Constructor for class org.mule.extension.socket.api.connection.tcp.protocol.LengthProtocol
 
LengthProtocol(int) - Constructor for class org.mule.extension.socket.api.connection.tcp.protocol.LengthProtocol
 
linger - Variable in class org.mule.extension.socket.api.socket.tcp.AbstractTcpSocketProperties
This sets the SO_LINGER value.
listen(SourceCallback<InputStream, SocketAttributes>) - Method in interface org.mule.extension.socket.api.connection.ListenerConnection
This method blocks until a new connection is received or timeout exception is thrown.
listen(SourceCallback<InputStream, SocketAttributes>) - Method in class org.mule.extension.socket.api.connection.tcp.TcpListenerConnection
One worker is created per accepted connection.
listen(SourceCallback<InputStream, SocketAttributes>) - Method in class org.mule.extension.socket.api.connection.udp.UdpListenerConnection
One worker is created per received package.
ListenerConfig - Class in org.mule.extension.socket.api.config
Implementation of AbstractSocketConfig for listener sockets
ListenerConfig() - Constructor for class org.mule.extension.socket.api.config.ListenerConfig
 
ListenerConnection - Interface in org.mule.extension.socket.api.connection
This kind of SocketConnection enables the SocketListener to await for new incoming connections and wraps each one of those into a SocketWorker so they can run independently in their own thread.
LOGGER - Variable in class org.mule.extension.socket.api.connection.AbstractSocketConnection
 

N

name - Variable in class org.mule.extension.socket.api.socket.AbstractSocketProperties
The name of this config object, so that it can be referenced by config elements.
newSocket(SocketConnectionSettings) - Method in class org.mule.extension.socket.api.connection.udp.AbstractUdpConnection
 
NO_MAX_LENGTH - Static variable in class org.mule.extension.socket.api.connection.tcp.protocol.AbstractByteProtocol
 
NO_STREAM - Static variable in class org.mule.extension.socket.api.connection.tcp.protocol.AbstractByteProtocol
 
nullIfEmptyArray(byte[]) - Method in class org.mule.extension.socket.api.connection.tcp.protocol.AbstractByteProtocol
 

O

objectSerializer - Variable in class org.mule.extension.socket.api.connection.tcp.protocol.AbstractByteProtocol
 
objectSerializer - Variable in class org.mule.extension.socket.api.connection.udp.AbstractUdpConnection
 
onComplete(Object) - Method in class org.mule.extension.socket.api.worker.SocketWorker
 
onComplete(Object) - Method in class org.mule.extension.socket.api.worker.TcpWorker
 
onComplete(Object) - Method in class org.mule.extension.socket.api.worker.UdpWorker
 
onError(Error, SourceCallbackContext) - Method in class org.mule.extension.socket.api.source.SocketListener
 
onError(Consumer<Exception>) - Method in class org.mule.extension.socket.api.worker.SocketWorker
 
onError(Throwable) - Method in class org.mule.extension.socket.api.worker.SocketWorker
 
onError(Throwable) - Method in class org.mule.extension.socket.api.worker.TcpWorker
 
onError(Throwable) - Method in class org.mule.extension.socket.api.worker.UdpWorker
 
onStart(SourceCallback<InputStream, SocketAttributes>) - Method in class org.mule.extension.socket.api.source.SocketListener
onStop() - Method in class org.mule.extension.socket.api.source.SocketListener
onSuccess(Object, SourceCallbackContext) - Method in class org.mule.extension.socket.api.source.SocketListener
 
org.mule.extension.socket.api - package org.mule.extension.socket.api
 
org.mule.extension.socket.api.client - package org.mule.extension.socket.api.client
 
org.mule.extension.socket.api.config - package org.mule.extension.socket.api.config
 
org.mule.extension.socket.api.connection - package org.mule.extension.socket.api.connection
 
org.mule.extension.socket.api.connection.tcp - package org.mule.extension.socket.api.connection.tcp
 
org.mule.extension.socket.api.connection.tcp.protocol - package org.mule.extension.socket.api.connection.tcp.protocol
 
org.mule.extension.socket.api.connection.udp - package org.mule.extension.socket.api.connection.udp
 
org.mule.extension.socket.api.exceptions - package org.mule.extension.socket.api.exceptions
 
org.mule.extension.socket.api.provider.tcp - package org.mule.extension.socket.api.provider.tcp
 
org.mule.extension.socket.api.provider.udp - package org.mule.extension.socket.api.provider.udp
 
org.mule.extension.socket.api.socket - package org.mule.extension.socket.api.socket
 
org.mule.extension.socket.api.socket.factory - package org.mule.extension.socket.api.socket.factory
 
org.mule.extension.socket.api.socket.tcp - package org.mule.extension.socket.api.socket.tcp
 
org.mule.extension.socket.api.socket.udp - package org.mule.extension.socket.api.socket.udp
 
org.mule.extension.socket.api.source - package org.mule.extension.socket.api.source
 
org.mule.extension.socket.api.worker - package org.mule.extension.socket.api.worker
 
org.mule.extension.socket.internal - package org.mule.extension.socket.internal
 

R

read() - Method in interface org.mule.extension.socket.api.client.SocketClient
This methods blocks until new data is available or SocketProperties.getClientTimeout() is reached, in which case a ReadingTimeoutException is thrown.
read() - Method in class org.mule.extension.socket.api.client.TcpClient
This methods blocks until new data is available or SocketProperties.getClientTimeout() is reached, in which case a ReadingTimeoutException is thrown.
read() - Method in class org.mule.extension.socket.api.client.UdpClient
This methods blocks until new data is available or SocketProperties.getClientTimeout() is reached, in which case a ReadingTimeoutException is thrown.
read(InputStream) - Method in class org.mule.extension.socket.api.connection.tcp.protocol.CustomClassLoadingLengthProtocol
 
read(InputStream) - Method in class org.mule.extension.socket.api.connection.tcp.protocol.CustomProtocol
 
read(InputStream) - Method in class org.mule.extension.socket.api.connection.tcp.protocol.DirectProtocol
Reads the input stream and returns a whole message.
read(InputStream) - Method in class org.mule.extension.socket.api.connection.tcp.protocol.LengthProtocol
It consumes the socket InputStream according to this#consume(InputStream) and then wraps the result into a ByteArrayInputStream.
read(InputStream) - Method in class org.mule.extension.socket.api.connection.tcp.protocol.SafeProtocol
Reads the actual data only after assuring that the cookie was preceding the message.
read(InputStream) - Method in class org.mule.extension.socket.api.connection.tcp.protocol.StreamingProtocol
Reads the input stream and returns a whole message.
read(InputStream) - Method in class org.mule.extension.socket.api.connection.tcp.protocol.XmlMessageProtocol
 
read(InputStream) - Method in interface org.mule.extension.socket.api.socket.tcp.TcpProtocol
Reads the input stream and returns a whole message.
ReadingTimeoutException - Exception in org.mule.extension.socket.api.exceptions
Thrown to indicate that a timeout has been reached while awaiting for new data to arrive and be read.
ReadingTimeoutException(String, Throwable) - Constructor for exception org.mule.extension.socket.api.exceptions.ReadingTimeoutException
 
receiveBufferSize - Variable in class org.mule.extension.socket.api.socket.AbstractSocketProperties
The size of the buffer (in bytes) used when receiving data, set on the socket itself.
remaining(int, int, int) - Method in class org.mule.extension.socket.api.connection.tcp.protocol.DirectProtocol
 
RequesterConfig - Class in org.mule.extension.socket.api.config
Implementation of AbstractSocketConfig for requester sockets
RequesterConfig() - Constructor for class org.mule.extension.socket.api.config.RequesterConfig
 
RequesterConnection - Interface in org.mule.extension.socket.api.connection
Provides the capability of obtaining a SocketClient which is aware of the underlying connection and can SocketClient#write(Object) and SocketClient.read() to and from the host to which it is connected.
RequesterSocketProperties - Interface in org.mule.extension.socket.api.socket
Interface for common configuration required on sockets that will send requests.
rethrowExceptionOnRead - Variable in class org.mule.extension.socket.api.connection.tcp.protocol.AbstractByteProtocol
Indicates if the exception should be rethrown if there is a failure while reading
run() - Method in class org.mule.extension.socket.api.worker.SocketWorker
 

S

SafeProtocol - Class in org.mule.extension.socket.api.connection.tcp.protocol
This protocol is an application level TcpProtocol and precedes every message with a cookie.
SafeProtocol() - Constructor for class org.mule.extension.socket.api.connection.tcp.protocol.SafeProtocol
 
safeRead(InputStream, byte[]) - Method in class org.mule.extension.socket.api.connection.tcp.protocol.AbstractByteProtocol
 
safeRead(InputStream, byte[], int) - Method in class org.mule.extension.socket.api.connection.tcp.protocol.AbstractByteProtocol
Manage non-blocking reads and handle errors
send(RequesterConnection, RequesterConfig, Object, String) - Method in class org.mule.extension.socket.api.SocketOperations
Sends the data using the client associated to the RequesterConnection.
sendAndReceive(RequesterConnection, RequesterConfig, Object, String) - Method in class org.mule.extension.socket.api.SocketOperations
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.
sendBufferSize - Variable in class org.mule.extension.socket.api.socket.AbstractSocketProperties
The size of the buffer (in bytes) used when sending data, set on the socket itself.
sendTcpNoDelay - Variable in class org.mule.extension.socket.api.socket.tcp.AbstractTcpSocketProperties
If set, transmitted data is not collected together for greater efficiency but sent immediately.
setClassLoader(ClassLoader) - Method in class org.mule.extension.socket.api.connection.tcp.protocol.CustomClassLoadingLengthProtocol
 
setEncoding(String) - Method in class org.mule.extension.socket.api.worker.SocketWorker
 
setFlowConstruct(FlowConstruct) - Method in class org.mule.extension.socket.api.source.SocketListener
setName(String) - Method in class org.mule.extension.socket.api.socket.AbstractSocketProperties
 
setObjectSerializer(ObjectSerializer) - Method in class org.mule.extension.socket.api.connection.tcp.protocol.AbstractByteProtocol
 
setObjectSerializer(ObjectSerializer) - Method in class org.mule.extension.socket.api.connection.tcp.protocol.SafeProtocol
 
setStreaming(boolean) - Method in class org.mule.extension.socket.internal.TcpInputStream
 
shutdownSocket() - Method in class org.mule.extension.socket.api.worker.TcpWorker
 
SimpleServerSocketFactory - Interface in org.mule.extension.socket.api.socket.factory
Interface for ServerSocket factories
SimpleSocketFactory - Interface in org.mule.extension.socket.api.socket.factory
Interface for Socket factories
socket - Variable in class org.mule.extension.socket.api.connection.udp.AbstractUdpConnection
 
SocketAttributes - Interface in org.mule.extension.socket.api
Canonical representation a connection's metadata attributes.
SocketClient - Interface in org.mule.extension.socket.api.client
Interface for common operations that can be done using a socket.
SocketConnection - Interface in org.mule.extension.socket.api.connection
Represents a connection established with a socket
SocketConnectionSettings - Class in org.mule.extension.socket.api
Groups host and port fields.
SocketConnectionSettings() - Constructor for class org.mule.extension.socket.api.SocketConnectionSettings
 
SocketConnectionSettings(Integer, String) - Constructor for class org.mule.extension.socket.api.SocketConnectionSettings
 
SocketListener - Class in org.mule.extension.socket.api.source
Listens for socket connections of the given protocol in the configured host and port.
SocketListener() - Constructor for class org.mule.extension.socket.api.source.SocketListener
 
SocketOperations - Class in org.mule.extension.socket.api
Basic set of operations for socket extension
SocketOperations() - Constructor for class org.mule.extension.socket.api.SocketOperations
 
socketProperties - Variable in class org.mule.extension.socket.api.connection.udp.AbstractUdpConnection
 
SocketProperties - Interface in org.mule.extension.socket.api.socket
Interface for objects that provide common configuration for generic sockets.
SocketsExtension - Class in org.mule.extension.socket.api
An extension for sending and receiving connections through both TCP and UDP protocols.
SocketsExtension() - Constructor for class org.mule.extension.socket.api.SocketsExtension
 
SocketUtils - Class in org.mule.extension.socket.internal
 
SocketWorker - Class in org.mule.extension.socket.api.worker
 
SocketWorker(SourceCallback<InputStream, SocketAttributes>) - Constructor for class org.mule.extension.socket.api.worker.SocketWorker
 
SslServerSocketFactory - Class in org.mule.extension.socket.api.socket.factory
Concrete implementation for SimpleServerSocketFactory.
SslServerSocketFactory(TlsContextFactory) - Constructor for class org.mule.extension.socket.api.socket.factory.SslServerSocketFactory
 
SslSocketFactory - Class in org.mule.extension.socket.api.socket.factory
Concrete implementation for SimpleSocketFactory.
SslSocketFactory(TlsContextFactory) - Constructor for class org.mule.extension.socket.api.socket.factory.SslSocketFactory
 
STREAM_OK - Static variable in class org.mule.extension.socket.api.connection.tcp.protocol.AbstractByteProtocol
 
StreamingProtocol - Class in org.mule.extension.socket.api.connection.tcp.protocol
This protocol is an application level TcpProtocol that wraps an InputStream and does not consume it.
StreamingProtocol() - Constructor for class org.mule.extension.socket.api.connection.tcp.protocol.StreamingProtocol
 
streamOk - Variable in class org.mule.extension.socket.api.connection.tcp.protocol.AbstractByteProtocol
 

T

TcpClient - Class in org.mule.extension.socket.api.client
This SocketClient implementation allows the reading and writing to and from a specific connected TCP Socket.
TcpClient(Socket, TcpProtocol) - Constructor for class org.mule.extension.socket.api.client.TcpClient
 
TcpClientSocketProperties - Class in org.mule.extension.socket.api.socket.tcp
Default immutable implementation of the TcpClientSocketProperties interface.
TcpClientSocketProperties() - Constructor for class org.mule.extension.socket.api.socket.tcp.TcpClientSocketProperties
 
TcpInputStream - Class in org.mule.extension.socket.internal
Used in TcpWorker as the input parameter for the read() method on the TcpProtocol interface.
TcpInputStream(InputStream) - Constructor for class org.mule.extension.socket.internal.TcpInputStream
 
TcpListenerConnection - Class in org.mule.extension.socket.api.connection.tcp
Implementation of ListenerConnection for receiving TCP connections.
TcpListenerConnection(SocketConnectionSettings, TcpProtocol, TcpServerSocketProperties, SimpleServerSocketFactory) - Constructor for class org.mule.extension.socket.api.connection.tcp.TcpListenerConnection
 
TcpListenerProvider - Class in org.mule.extension.socket.api.provider.tcp
A ConnectionProvider which provides instances of TcpListenerConnection to be used by SocketListener
TcpListenerProvider() - Constructor for class org.mule.extension.socket.api.provider.tcp.TcpListenerProvider
 
TcpProtocol - Interface in org.mule.extension.socket.api.socket.tcp
This interface enables to plug different application level protocols into the SocketsExtension.
TcpRequesterConnection - Class in org.mule.extension.socket.api.connection.tcp
Implementation of RequesterConnection for establishing TCP connections.
TcpRequesterConnection(SocketConnectionSettings, SocketConnectionSettings, TcpProtocol, TcpClientSocketProperties, SimpleSocketFactory) - Constructor for class org.mule.extension.socket.api.connection.tcp.TcpRequesterConnection
 
TcpRequesterProvider - Class in org.mule.extension.socket.api.provider.tcp
A ConnectionProvider which provides instances of TcpRequesterConnection to be used by the SocketOperations
TcpRequesterProvider() - Constructor for class org.mule.extension.socket.api.provider.tcp.TcpRequesterProvider
 
TcpServerSocketFactory - Class in org.mule.extension.socket.api.socket.factory
Concrete implementation for SimpleServerSocketFactory.
TcpServerSocketFactory() - Constructor for class org.mule.extension.socket.api.socket.factory.TcpServerSocketFactory
 
TcpServerSocketProperties - Class in org.mule.extension.socket.api.socket.tcp
Default immutable implementation of the TcpServerSocketProperties interface.
TcpServerSocketProperties() - Constructor for class org.mule.extension.socket.api.socket.tcp.TcpServerSocketProperties
 
TcpSocketFactory - Class in org.mule.extension.socket.api.socket.factory
Concrete implementation for SimpleSocketFactory.
TcpSocketFactory() - Constructor for class org.mule.extension.socket.api.socket.factory.TcpSocketFactory
 
TcpSocketProperties - Interface in org.mule.extension.socket.api.socket.tcp
Interface for objects that provide common TCP configuration that applies for both client and server sockets.
TcpWorker - Class in org.mule.extension.socket.api.worker
Only one worker will be created per each new TCP connection accepted by the TcpListenerConnection.listen(SourceCallback), This class is responsible for reading from that connection is closed by the sender, or Source is stopped.
TcpWorker(Socket, TcpProtocol, SourceCallback<InputStream, SocketAttributes>) - Constructor for class org.mule.extension.socket.api.worker.TcpWorker
 
TIMEOUT_CONFIGURATION - Static variable in class org.mule.extension.socket.api.socket.AbstractSocketProperties
 
TLS - Static variable in class org.mule.extension.socket.api.SocketsExtension
 
TLS_CONFIGURATION - Static variable in class org.mule.extension.socket.api.SocketsExtension
 
toString() - Method in class org.mule.extension.socket.api.SocketConnectionSettings
 

U

UdpClient - Class in org.mule.extension.socket.api.client
This SocketClient implementation allows the reading and writing to and from a specific UDP DatagramSocket.
UdpClient(DatagramSocket, SocketConnectionSettings, UdpSocketProperties, ObjectSerializer) - Constructor for class org.mule.extension.socket.api.client.UdpClient
 
UdpListenerConnection - Class in org.mule.extension.socket.api.connection.udp
 
UdpListenerConnection(SocketConnectionSettings, UdpSocketProperties) - Constructor for class org.mule.extension.socket.api.connection.udp.UdpListenerConnection
 
UdpListenerProvider - Class in org.mule.extension.socket.api.provider.udp
A ConnectionProvider which provides instances of UdpListenerConnection to be used by SocketListener
UdpListenerProvider() - Constructor for class org.mule.extension.socket.api.provider.udp.UdpListenerProvider
 
UdpRequesterConnection - Class in org.mule.extension.socket.api.connection.udp
Implementation of RequesterConnection for UDP connections.
UdpRequesterConnection(SocketConnectionSettings, SocketConnectionSettings, UdpSocketProperties) - Constructor for class org.mule.extension.socket.api.connection.udp.UdpRequesterConnection
 
UdpRequesterProvider - Class in org.mule.extension.socket.api.provider.udp
A ConnectionProvider which provides instances of UdpRequesterConnection to be used by the SocketOperations
UdpRequesterProvider() - Constructor for class org.mule.extension.socket.api.provider.udp.UdpRequesterProvider
 
UdpSocketProperties - Class in org.mule.extension.socket.api.socket.udp
Default immutable implementation of the UdpSocketProperties interface.
UdpSocketProperties() - Constructor for class org.mule.extension.socket.api.socket.udp.UdpSocketProperties
 
UdpWorker - Class in org.mule.extension.socket.api.worker
One worker is created per received package.
UdpWorker(DatagramSocket, DatagramPacket, ObjectSerializer, SourceCallback<InputStream, SocketAttributes>) - Constructor for class org.mule.extension.socket.api.worker.UdpWorker
 
UNLIMITED - Static variable in class org.mule.extension.socket.api.connection.tcp.protocol.DirectProtocol
 
UnresolvableHostException - Exception in org.mule.extension.socket.api.exceptions
Thrown to indicate an error resolving an InetSocketAddress
UnresolvableHostException(String) - Constructor for exception org.mule.extension.socket.api.exceptions.UnresolvableHostException
 

V

validate() - Method in interface org.mule.extension.socket.api.connection.SocketConnection
Validates socket's connection
validate() - Method in class org.mule.extension.socket.api.connection.tcp.TcpListenerConnection
Validates socket's connection
validate() - Method in class org.mule.extension.socket.api.connection.tcp.TcpRequesterConnection
Validates socket's connection
validate() - Method in class org.mule.extension.socket.api.connection.udp.AbstractUdpConnection
 
validate(TcpListenerConnection) - Method in class org.mule.extension.socket.api.provider.tcp.TcpListenerProvider
validate(TcpRequesterConnection) - Method in class org.mule.extension.socket.api.provider.tcp.TcpRequesterProvider
validate(UdpListenerConnection) - Method in class org.mule.extension.socket.api.provider.udp.UdpListenerProvider
 
validate(UdpRequesterConnection) - Method in class org.mule.extension.socket.api.provider.udp.UdpRequesterProvider
 
validate(AbstractSocketConnection) - Static method in class org.mule.extension.socket.internal.SocketUtils
 

W

wasDisconnected - Variable in class org.mule.extension.socket.api.connection.AbstractSocketConnection
 
WORK - Static variable in class org.mule.extension.socket.internal.SocketUtils
 
write(Object, String) - Method in interface org.mule.extension.socket.api.client.SocketClient
 
write(Object, String) - Method in class org.mule.extension.socket.api.client.TcpClient
write(Object, String) - Method in class org.mule.extension.socket.api.client.UdpClient
write(OutputStream, Object, String) - Method in class org.mule.extension.socket.api.connection.tcp.protocol.CustomProtocol
 
write(OutputStream, Object, String) - Method in class org.mule.extension.socket.api.connection.tcp.protocol.DirectProtocol
 
write(OutputStream, Object, String) - Method in class org.mule.extension.socket.api.connection.tcp.protocol.SafeProtocol
Write the specified message into the OutputStream.
write(OutputStream, Object, String) - Method in class org.mule.extension.socket.api.connection.tcp.protocol.StreamingProtocol
 
write(OutputStream, Object, String) - Method in class org.mule.extension.socket.api.connection.tcp.protocol.XmlMessageProtocol
 
write(OutputStream, Object, String) - Method in interface org.mule.extension.socket.api.socket.tcp.TcpProtocol
Write the specified message into the OutputStream.
writeByteArray(OutputStream, byte[]) - Method in class org.mule.extension.socket.api.connection.tcp.protocol.AbstractByteProtocol
 
writeByteArray(OutputStream, byte[]) - Method in class org.mule.extension.socket.api.connection.tcp.protocol.LengthProtocol
It first writes the an int representing the length of the data to be written, and then writes the actual data.

X

XmlMessageEOFProtocol - Class in org.mule.extension.socket.api.connection.tcp.protocol
Extend XmlMessageProtocol to continue reading until either a new message or EOF is found.
XmlMessageEOFProtocol() - Constructor for class org.mule.extension.socket.api.connection.tcp.protocol.XmlMessageEOFProtocol
 
XmlMessageProtocol - Class in org.mule.extension.socket.api.connection.tcp.protocol
The XmlMessageProtocol is an application level tcp protocol that can be used to read streaming xml documents.
XmlMessageProtocol() - Constructor for class org.mule.extension.socket.api.connection.tcp.protocol.XmlMessageProtocol
 
A B C D E F G H I K L N O R S T U V W X 
Skip navigation links

Copyright © 2003–2017 MuleSoft, Inc.. All rights reserved.