# mulesoft Sockets Connector - Full Documentation

<!-- document id=1664aa0becf96e16ce8ed026fe53aaada4b72d49346c7a2d61b2eee052bbbd47 url=/mulesoft/current/en-us/sockets-connector/latest/index.md -->

---
product: Sockets Connector
version: 1.2
is-latest-version: true
---

# Sockets Connector 1.2

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Connector for Sockets (Sockets Connector) provides a sockets listener, send capability, and
send and receive functionality. Additionally, it provides TCP and UDP requesters.

## Before You Begin

To use this connector, you must be familiar with:

- Anypoint Connectors

- Mule runtime engine (Mule)

- Elements in a Mule flow

- Global elements

- Creating a Mule app using Anypoint Studio

Before creating an app, you must have access to Anypoint Platform and Anypoint Studio.

## Audience

- New user, read:

  - [Using Anypoint Studio to Configure the Connector](https://docs.mulesoft.com/sockets-connector/latest/sockets-connector-studio) to create your Mule
    app

  - [Examples](https://docs.mulesoft.com/sockets-connector/latest/sockets-connector-examples), which provides one or more use cases for the connector

- Advanced user, read:

  - [XML and Maven Support](https://docs.mulesoft.com/sockets-connector/latest/sockets-connector-xml-maven)

  - [Examples](https://docs.mulesoft.com/sockets-connector/latest/sockets-connector-examples), which provides one or more use cases for the connector

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange)

- [Sockets Connector in Exchange](https://anypoint.mulesoft.com/exchange/org.mule.connectors/mule-sockets-connector/)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=ec64f68a2aa9b4365a61592459809132421e391dae9f7e0ca85b069f419c2dd5 url=/mulesoft/current/en-us/sockets-connector/latest/sockets-documentation.md -->

---
product: Sockets Connector
version: 1.2
is-latest-version: true
---

# Sockets Connector Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Sockets Connector v1.2

Anypoint Connector for Sockets (Sockets Connector) provides a sockets listener, send capability, and
send and receive functionality. Provides TCP and UDP requesters.

Release Notes: [Sockets Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/connector-sockets)

## Configurations

---

### Listener Config

Config for listener sockets

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name for this configuration. Connectors reference the configuration with this name.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><ul><li><p><a href="#listener-config_tcp-listener">Tcp Listener</a></p></li><li><p><a href="#listener-config_udp-listener">Udp Listener</a></p></li></ul></div></div></td><td><div><div><p>The connection types to provide to this configuration.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Expiration Policy</strong></p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><div><div><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Connection Types

##### Tcp Listener

A ConnectionProvider which provides instances of TcpListenerConnection to use by SocketListener

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Protocol</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#SafeProtocol">Safe Protocol</a></p></li><li><p><a href="#DirectProtocol">Direct Protocol</a></p></li><li><p><a href="#LengthProtocol">Length Protocol</a></p></li><li><p><a href="#StreamingProtocol">Streaming Protocol</a></p></li><li><p><a href="#XmlMessageProtocol">XML Message Protocol</a></p></li><li><p><a href="#xml-message-eof-protocol">XML Message Eof Protocol</a></p></li><li><p><a href="#CustomProtocol">Custom Protocol</a></p></li><li><p><a href="#eof-protocol">Eof Protocol</a></p></li><li><p><a href="#CustomClassLoadingLengthProtocol">Custom Class Loading Length Protocol</a></p></li></ul></div></div></td><td><div><div><p>TcpProtocol that knows how the data is read and written. If not specified, uses SafeProtocol.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>TLS Configuration</strong></p></td><td><div><div><p><a href="#Tls">Tls</a></p></div></div></td><td><div><div><p>Implies the use of SSLServerSocket instead of plain TCP ServerSocket for accepting new SSL connections.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Connection’s port number</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Connection’s host name</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Send Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The size of the buffer (in bytes) used when sending data, set on the socket itself.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Receive Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The size of the buffer (in bytes) used when receiving data, set on the socket itself.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Client Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Sets the SO_TIMEOUT value on sockets, and indicates the amount of time (in milliseconds) that the socket waits in a blocking operation before failing. A value of 0 (default) indicates waiting indefinitely.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reuse Address</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Sets SO_REUSEADDRESS (default) value on the sockets before binding, which helps reduce "address already in use" errors when a socket is reused.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Send TCP With No Delay</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If set, it does not collect transmitted data together for greater efficiency but sends it immediately. Defaults to true even though socket default is false, because optimizing to reduce amount of network traffic over latency is hardly ever a concern today.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Linger</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Sets SO_LINGER value, and indicates how long (in milliseconds) the socket takes to close, so any remaining data transmits correctly.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Keep Alive</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Enables SO_KEEPALIVE behavior on open sockets. This automatically checks open socket connections but unused for long periods and closes them if the connection becomes unavailable. This is a property on the socket itself and a server socket uses it to control whether connections to the server keep alive before they recycle.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Fail On Unresolved Host</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether the socket fails during its creation if the host set on the endpoint cannot be resolved. However, set it to false to allow unresolved hosts, which is useful when connecting through a proxy.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Server Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Sets SO_TIMEOUT value when you use the socket as a server. The timeout that applies to the "accept" operation. If no connection arrives, a value of 0 (default) causes the accept to wait indefinitely.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Receive Backlog</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum queue length for incoming connections.</p></div></div></td><td><div><div><p>50</p></div></div></td><td><div></div></td></tr></tbody></table>

##### UDP Listener

A ConnectionProvider which provides instances of UdpListenerConnection to use by SocketListener

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Connection’s port number</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Connection’s host name</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Send Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The size of the buffer (in bytes) used when sending data, set on the socket itself.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Receive Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The size of the buffer (in bytes) used when receiving data, set on the socket itself.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Client Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Sets the SO_TIMEOUT value on sockets, and indicates the amount of time (in milliseconds) that the socket waits in a blocking operation before failing. A value of 0 (default) indicates waiting indefinitely.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reuse Address</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Sets SO_REUSEADDRESS (default) value on the sockets before binding, which helps reduce "address already in use" errors when a socket is reused.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Broadcast</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Enable or disable SO_BROADCAST value into the DatagramSocket</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr></tbody></table>

#### Associated Sources

- [Listener](#listener)

---

### Request Config

Config for requester sockets

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name for this configuration. Connectors reference the configuration with this name.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><ul><li><p><a href="#request-config_tcp-requester">Tcp Requester</a></p></li><li><p><a href="#request-config_udp-requester">Udp Requester</a></p></li></ul></div></div></td><td><div><div><p>The connection types to provide to this configuration.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Expiration Policy</strong></p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><div><div><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Connection Types

##### Tcp Requester

A ConnectionProvider which provides instances of TcpRequesterConnection to use by the
SocketOperations

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Local Address Settings</strong></p></td><td><div><div><p><a href="#SocketConnectionSettings">Socket Connection Settings</a></p></div></div></td><td><div><div><p>This configuration parameter refers to the address where the Socket should bind to.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Protocol</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#SafeProtocol">Safe Protocol</a></p></li><li><p><a href="#DirectProtocol">Direct Protocol</a></p></li><li><p><a href="#LengthProtocol">Length Protocol</a></p></li><li><p><a href="#StreamingProtocol">Streaming Protocol</a></p></li><li><p><a href="#XmlMessageProtocol">XML Message Protocol</a></p></li><li><p><a href="#xml-message-eof-protocol">XML Message Eof Protocol</a></p></li><li><p><a href="#CustomProtocol">Custom Protocol</a></p></li><li><p><a href="#eof-protocol">Eof Protocol</a></p></li><li><p><a href="#CustomClassLoadingLengthProtocol">Custom Class Loading Length Protocol</a></p></li></ul></div></div></td><td><div><div><p>TcpProtocol that knows how the data is read and written. If not specified, the SafeProtocol will be used.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>TLS Configuration</strong></p></td><td><div><div><p><a href="#Tls">Tls</a></p></div></div></td><td><div><div><p>Implies the use of SSLServerSocket instead of plain TCP ServerSocket for accepting new SSL connections.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Connection’s port number</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Connection’s host name</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Pooling Profile</strong></p></td><td><div><div><p><a href="#PoolingProfile">Pooling Profile</a></p></div></div></td><td><div><div><p>Characteristics of the connection pool</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Send Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The size of the buffer (in bytes) used when sending data, set on the socket itself.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Receive Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The size of the buffer (in bytes) used when receiving data, set on the socket itself.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Client Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Sets the SO_TIMEOUT value on sockets, and indicates the amount of time (in milliseconds) that the socket waits in a blocking operation before failing. A value of 0 (default) indicates waiting indefinitely.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reuse Address</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Sets SO_REUSEADDRESS (default) value on the sockets before binding, which helps reduce "address already in use" errors when a socket is reused.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Send TCP With No Delay</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If set, it does not collect transmitted data together for greater efficiency but sends it immediately. Defaults to true even though socket default is false, because optimizing to reduce amount of network traffic over latency is hardly ever a concern today.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Linger</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Sets SO_LINGER value, and indicates how long (in milliseconds) the socket takes to close, so any remaining data transmits correctly.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Keep Alive</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Enables SO_KEEPALIVE behavior on open sockets. This automatically checks open socket connections but unused for long periods and closes them if the connection becomes unavailable. This is a property on the socket itself and a server socket uses it to control whether connections to the server keep alive before they recycle.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Fail On Unresolved Host</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether the socket fails during its creation and if the host set on the endpoint cannot be resolved. However, set it to false to allow unresolved hosts, which is useful when connecting through a proxy.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Number of milliseconds to wait until an outbound connection to a remote server is successfully created. Defaults to 30 seconds.</p></div></div></td><td><div><div><p>30</p></div></div></td><td><div></div></td></tr></tbody></table>

##### UDP Requester

A ConnectionProvider which provides instances of UdpRequesterConnection to use by the
SocketOperations

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Local Address Settings</strong></p></td><td><div><div><p><a href="#SocketConnectionSettings">Socket Connection Settings</a></p></div></div></td><td><div><div><p>This configuration parameter refers to the address where the DatagramSocket should bind to.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Connection’s port number</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Connection’s host name</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Pooling Profile</strong></p></td><td><div><div><p><a href="#PoolingProfile">Pooling Profile</a></p></div></div></td><td><div><div><p>Characteristics of the connection pool</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Send Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The size of the buffer (in bytes) used when sending data, set on the socket itself.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Receive Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The size of the buffer (in bytes) used when receiving data, set on the socket itself.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Client Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Sets the SO_TIMEOUT value on sockets, and indicates the amount of time (in milliseconds) that the socket waits in a blocking operation before failing. A value of 0 (default) indicates waiting indefinitely.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reuse Address</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Sets SO_REUSEADDRESS (default) value on the sockets before binding, which helps reduce "address already in use" errors when a socket is reused.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Broadcast</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Enable or disable SO_BROADCAST value into the DatagramSocket</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr></tbody></table>

## Supported Operations

- [Send](#send)

- [Send And Receive](#sendAndReceive)

## Operations

### Send

`<sockets:send>`

Sends the data using the client associated to the RequesterConnection.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Content</strong></p></td><td><div><div><p>Binary</p></div></div></td><td><div><div><p>data that will be serialized and sent through the socket.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### For Configurations

- [Request Config](#request-config)

#### Throws

- SOCKETS:UNKNOWN\_HOST

- SOCKETS:CONNECTIVITY

- SOCKETS:CONNECTION\_TIMEOUT

- SOCKETS:RETRY\_EXHAUSTED

- SOCKETS:LENGTH\_EXCEEDED

### Send And Receive

`<sockets:send-and-receive>`

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 returns a null payload.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Content</strong></p></td><td><div><div><p>Binary</p></div></div></td><td><div><div><p>data that will be serialized and sent through the socket.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Output Mime Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The mime type of the payload that this operation outputs.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Output Encoding</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The encoding of the payload that this operation outputs.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><div><div><p>Configure if repeatable streams should be used and their behavior</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Binary</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#ImmutableSocketAttributes">Immutable Socket Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Request Config](#request-config)

#### Throws

- SOCKETS:UNKNOWN\_HOST

- SOCKETS:CONNECTIVITY

- SOCKETS:CONNECTION\_TIMEOUT

- SOCKETS:RETRY\_EXHAUSTED

- SOCKETS:LENGTH\_EXCEEDED

## Sources

### Listener

`<sockets:listener>`

Listens for socket connections of the given protocol in the configured host and port. Whenever a new
connection is received, this Source will schedule a SocketWorker that will handle the communication
for that particular connection.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Output Mime Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The mime type of the payload that this operation outputs.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Output Encoding</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The encoding of the payload that this operation outputs.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Primary Node Only</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether this source should only executes on the primary node when running in a cluster</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><div><div><p>Configure if repeatable streams should be used and their behavior</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Redelivery Policy</strong></p></td><td><div><div><p><a href="#RedeliveryPolicy">Redelivery Policy</a></p></div></div></td><td><div><div><p>Defines a policy for processing the redelivery of the same message</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Response Value</strong></p></td><td><div><div><p>Binary</p></div></div></td><td><div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Binary</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#ImmutableSocketAttributes">Immutable Socket Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Listener Config](#listener-config)

## Types

### Tls

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Enabled Protocols</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>A comma-separated list of protocols enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enabled Cipher Suites</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>A comma-separated list of cipher suites enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Trust Store</strong></p></td><td><div><div><p><a href="#TrustStore">Trust Store</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Store</strong></p></td><td><div><div><p><a href="#KeyStore">Key Store</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Revocation Check</strong></p></td><td><div><div><ul><li><p><a href="#standard-revocation-check">Standard Revocation Check</a></p></li><li><p><a href="#custom-ocsp-responder">Custom Ocsp Responder</a></p></li><li><p><a href="#crl-file">Crl File</a></p></li></ul></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Trust Store

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The location of the trust store. This location resolves relative to the current classpath and file system, if possible.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The password used to protect the trust store.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The type of store used.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The algorithm used by the trust store.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Insecure</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If true, no certificate validations are performed, rendering connections vulnerable to attacks. Use at your own risk.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Key Store

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The location of the trust store. This location resolves relative to the current classpath and file system, if possible.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The type of store used.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>When the key store contains many private keys, this attribute indicates the alias of the key to use. If not defined, the first key in the file is used by default.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The password used to protect the private key.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The password used to protect the key store.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The algorithm used by the key store.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Standard Revocation Check

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Only End Entities</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Only verify the last element of the certificate chain.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Prefer Crls</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Try CRL instead of OCSP first.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>No Fallback</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Do not use the secondary checking method.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Soft Fail</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Avoid verification failure when the revocation server can not be reached or is busy.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Custom Ocsp Responder

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The URL of the OCSP responder.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Cert Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Alias of the signing certificate for the OCSP response (must be in the trust store), if present.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Crl File

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The path to the CRL file.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnection

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Fails Deployment</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>The reconnection strategy to use.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often in milliseconds to reconnect</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How many reconnection attempts to make.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect Forever

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often in milliseconds to reconnect</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Expiration Policy

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Idle Time</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>A time unit that qualifies the maxIdleTime attribute</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Immutable Socket Attributes

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Host Address</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Host Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Local Certificates</strong></p></td><td><div><div><p>Array of Any</p></div></div></td><td><div><div><p>The SSL local certificates. If the Socket is not an SSL Sockets, this is null.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Peer Certificates</strong></p></td><td><div><div><p>Array of Any</p></div></div></td><td><div><div><p>The SSL peer certificates. If the Socket is not an SSL Sockets, this is null.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable In Memory Stream

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Initial Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The allocated amount of memory to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Size Increment</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer does not expand, and STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>The unit in which all these attributes are expressed</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable File Store Stream

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>In Memory Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed content on the disk is buffered.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>The unit in which maxInMemorySize is expressed</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Redelivery Policy

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Redelivery Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Use Secure Hash</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether to use a secure hash algorithm to identify a redelivered message.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Message Digest Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The secure hashing algorithm to use. If not set, defaults to SHA-256.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Id Expression</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Defines one or more expressions to use to determine when a message is redelivered. This property may only be set if useSecureHash is false.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Object Store</strong></p></td><td><div><div><p>Object Store</p></div></div></td><td><div><div><p>The object store to store the redelivery counter for each message.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Socket Connection Settings

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Connection’s port number</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Connection’s host name</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Pooling Profile

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Active</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Controls the maximum number of Mule components that can be borrowed from a session at one time. When set to a negative value, there is no limit to the number of components that can be active at one time. When maxActive is exceeded, the pool exhausts.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Idle</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Controls the maximum number of Mule components that can sit idle in the pool at any time. When set to a negative value, there is no limit to the number of Mule components that can be idle at one time.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Wait</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Specifies the number of milliseconds to wait for a pooled component to become available when the pool is exhausted and the exhaustedAction is set to WHEN_EXHAUSTED_WAIT.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Min Eviction Millis</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Determines the minimum amount of time an object may sit idle in the pool before it is eligible for eviction. When nonpositive, no objects will be evicted from the pool due to idle time alone.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Eviction Check Interval Millis</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Specifies the number of milliseconds between runs of the object evictor. When non-positive, no object evictor is executed.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Exhausted Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>WHEN_EXHAUSTED_GROW</p></li><li><p>WHEN_EXHAUSTED_WAIT</p></li><li><p>WHEN_EXHAUSTED_FAIL</p></li></ul></div></div></td><td><div><div><p>Specifies the behavior of the Mule component pool when the pool is exhausted. Possible values are: WHEN_EXHAUSTED_FAIL, which throws a NoSuchElementException, WHEN_EXHAUSTED_WAIT, which blocks by invoking Object.wait(long) until a new or idle object is available, or WHEN_EXHAUSTED_GROW, which creates a new Mule instance and return it, essentially making maxActive meaningless. If a positive maxWait value is supplied, it blocks for at most that many milliseconds, after which a NoSuchElementException will be thrown. If maxThreadWait is a negative value, it blocks indefinitely.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Initialisation Policy</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>INITIALISE_NONE</p></li><li><p>INITIALISE_ONE</p></li><li><p>INITIALISE_ALL</p></li></ul></div></div></td><td><div><div><p>Determines how components in a pool can initialize. The possible values are INITIALISE_NONE does not load any components into the pool on startup, INITIALISE_ONE loads one initial component into the pool on startup, or INITIALISE_ALL loads all components in the pool on startup</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Disabled</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether pooling should be disabled</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Safe Protocol

This test protocol precedes every message with a cookie, and should not be used in production
environments.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Message Length</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Indicates the maximum length of the message.</p></div></div></td><td><div><div><p>-1</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Encoding</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Indicates the encoding used for serializing the cookie</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Rethrow Exception On Read</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates if the exception should be rethrown if there is a failure while reading</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr></tbody></table>

### Direct Protocol

This protocol allows the socket to read until no more bytes are immediately available. On slow
networks, `EOFProtocol` and `LengthProtocol` might be more reliable.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Rethrow Exception On Read</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates if the exception should be rethrown if there is a failure while reading</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr></tbody></table>

### Length Protocol

This protocol is defined by sending or reading an integer (the packet length) and then the data to
transfer.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Message Length</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Indicates the maximum length of the message.</p></div></div></td><td><div><div><p>-1</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Rethrow Exception On Read</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates if the exception should be rethrown if there is a failure while reading</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr></tbody></table>

### Streaming Protocol

This protocol allows the socket’s Send operation to return a message with the original InputStream
as payload.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Rethrow Exception On Read</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates if the exception should be rethrown if there is a failure while reading</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr></tbody></table>

### XML Message Protocol

This protocol reads streaming XML documents. The only requirement is that each document includes an
XML declaration at the beginning of the document in the form of `<?xml…​.`. Data is read until a new
document is found or until there is no more currently available data. For slower networks,
`XmlMessageEofProtocol` might be more reliable. Also, because the default character encoding for
Anypoint Platform is used to decode the message bytes when looking for the XML declaration, some
caution with message character encodings is warranted.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Rethrow Exception On Read</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates if the exception should be rethrown if there is a failure while reading</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr></tbody></table>

### XML Message Eof Protocol

This protocol extends `XmlMessageProtocol` to continue reading until either a new message or EOF is
found.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Rethrow Exception On Read</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates if the exception should be rethrown if there is a failure while reading</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr></tbody></table>

### Custom Protocol

Define your own custom protocol by writing a class that extends `TcpProtocol`.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Class</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Reference to full qualifier class name that should extend TcpProtocol to use as a custom protocol</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Eof Protocol

When clients connect to a server using the EOF protocol, they write the message on the socket
connection output stream. To signal the end of the message, clients must signal the end of file
(EOF) by closing the output stream and keeping the input stream open, waiting for a response from
the server. This behavior is known as half-close. Then, the server sends a response and closes its
output stream and the whole socket connection.

For TLS secured connections, use TLS 1.3 and JDK 11 as the half-close feature is not supported in
TLS 1.2 and earlier versions. The half-close feature triggers the close notification alert to
prevent TLS truncation attacks. JDK 11 and newer versions support TLS 1.3. Also, pooling profile is
not compatible with `EofProtocol`.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Rethrow Exception On Read</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates if the exception should be rethrown if there is a failure while reading</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr></tbody></table>

### Custom Class Loading Length Protocol

A length protocol that uses a specific class loader to load objects from streams.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Class Loader</strong></p></td><td><div><div><p>Any</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Message Length</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Indicates the maximum length of the message.</p></div></div></td><td><div><div><p>-1</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Rethrow Exception On Read</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates if the exception should be rethrown if there is a failure while reading</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr></tbody></table>

## See Also

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=26533a3e0ef018dae11671d9e89dd412e1f1a4866c5c5ac73fe0f2956eeccc67 url=/mulesoft/current/en-us/sockets-connector/latest/sockets-connector-xml-maven.md -->

---
product: Sockets Connector
version: 1.2
is-latest-version: true
---

# Sockets Connector XML and Maven Support

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio.

If you manually code a Mule runtime engine (Mule) app in XML, either from the Anypoint Studio XML
editor or from a text editor, you can get access to the connector in your app by adding reference
statements to both your XML Mule flow and the Apache Maven `pom.xml` file.

When you install the connector in Studio, Studio automatically populates the XML code with the
connector’s namespace and schema location. It also adds a dependency to the `pom.xml` file.

## Add a Namespace for the Connector

Paste the following code inside the `<mule>` tag of the header of your configuration XML:

```xml
http://www.mulesoft.org/schema/mule/sockets
http://www.mulesoft.org/schema/mule/sockets/current/mule-sockets.xsd
```

This example shows how the namespace statements are placed in the `<mule>` XML block:

```xml
<mule xmlns:sockets="http://www.mulesoft.org/schema/mule/sockets"
	xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns:file="http://www.mulesoft.org/schema/mule/file"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core
	http://www.mulesoft.org/schema/mule/core/current/mule.xsd
	http://www.mulesoft.org/schema/mule/file
	http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd
	http://www.mulesoft.org/schema/mule/http
	http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
	http://www.mulesoft.org/schema/mule/ee/core
	http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
	http://www.mulesoft.org/schema/mule/sockets
	http://www.mulesoft.org/schema/mule/sockets/current/mule-sockets.xsd">
```

## Add a POM File Dependency

The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app.
If you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to
this connector:

```xml
<dependency>
  <groupId>org.mule.connectors</groupId>
  <artifactId>mule-sockets-connector</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>
```

Replace `x.x.x` with the version that corresponds to the connector you are using.

To obtain the most up-to-date `pom.xml` file information:

1.  Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/).

2.  In Exchange, click **Login** and supply your Anypoint Platform username and password.

3.  In Exchange, search for `Sockets`.

4.  Select the connector.

5.  Click **Dependency Snippets** near the upper right of the screen.

## Next Step

After completing your namespace and `pom.xml` file, you can try the
[Examples](https://docs.mulesoft.com/sockets-connector/latest/sockets-connector-examples).

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=73154ec1529750f0b2c0b6af632cb2662ec7c89ee589b0632b4a096e2395d0d7 url=/mulesoft/current/en-us/sockets-connector/latest/sockets-connector-examples.md -->

---
product: Sockets Connector
version: 1.2
is-latest-version: true
---

# Sockets Examples

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Connector for Sockets (Sockets Connector) enables you to send or receive transport layer
packages through both UDP and TCP sockets. The following examples show you how to use the available
operations while taking into consideration the transport layer protocol you want to implement in
your application, and how to create a custom TPC protocol

## Send a Message

In the following example, you have set up your Socket Listener and you want to build an application
that upon receiving specific data from an external client, performs a database query and sends a
message to a UDP Server Socket with the obtained results. Note that, even though we chose UDP for
this example, you can use the Send operation to send messages to both TCP and UDP sockets:

```xml
	<sockets:listener-config name="Sockets_Listener_config" doc:name="Sockets Listener config">
		<sockets:tcp-listener-connection host="localhost" port="8082" >
			<sockets:protocol >
				<sockets:direct-protocol />
			</sockets:protocol>
		</sockets:tcp-listener-connection>
	</sockets:listener-config>

	<db:config name="Database_Config" doc:name="Database Config">
		<db:oracle-connection host="localhost" user="sys as sysdba" password="Oradoc_db1" serviceName="orclpdb1.localdomain" />
	</db:config>

	<sockets:request-config name="Sockets_Request_config" doc:name="Sockets Request config" >
		<sockets:udp-requester-connection host="localhost" port="8085" />
	</sockets:request-config>

	<flow name="socketSearchDatabaseAndReturnResult">
		<sockets:listener doc:name="Listener" config-ref="Sockets_Listener_config" outputMimeType="application/json"/>
		<db:select doc:name="Select" config-ref="Database_Config">
			<db:sql>#["SELECT first_name, last_name from SYSTEM.MUSICIANS where id = :id"]</db:sql>
			<db:input-parameters><![CDATA[#[{ 'id': payload.id }]]]></db:input-parameters>
		</db:select>
		<logger level="INFO" doc:name="Logger" message="#[payload]" />
		<sockets:send doc:name="Send" config-ref="Sockets_Request_config">
			<sockets:content ><![CDATA[#[output application/json --- 'name': payload[0].FIRST_NAME as String ++ ' ' ++ payload[0].LAST_NAME as String]]]></sockets:content>
		</sockets:send>
	</flow>
```

To test this example:

1.  Initialize an Oracle database by using the following script:

```xml
    CREATE TABLE SYSTEM.MUSICIANS(
        id INTEGER GENERATED BY DEFAULT AS IDENTITY,
        age INTEGER,
        first_name VARCHAR2(100),
        last_name VARCHAR2(100),
        PRIMARY KEY(id)
    );

    INSERT INTO SYSTEM.MUSICIANS(age, first_name, last_name) VALUES(37, 'Farrokh', 'Bulsara');
    INSERT INTO SYSTEM.MUSICIANS(age, first_name, last_name) VALUES(36, 'Brian Harold', 'May');
    INSERT INTO SYSTEM.MUSICIANS(age, first_name, last_name) VALUES(35, 'Roger', 'Meddows Taylor');
    INSERT INTO SYSTEM.MUSICIANS(age, first_name, last_name) VALUES(32, 'John', 'Deacon');
```

2.  At port 8085, start a UDP server to which the results will be sent by running the netcat command
    `nc -ul 8085`.

3.  Run your Mule application and start a TCP client socket to send the expected query parameter by
    running netcat command `nc localhost 8082` and sending the data `{"id": 2}`.

## Send and Receive Messages

Because sockets are full-duplex, they allow bidirectional communication, enabling you to send and
receive messages simultaneously. The following example operation is slightly different from the
example of only sending a message because this example not only sends data to the client but also
expects a response.  
This operation can be used for both TCP and UDP sockets.

The operation will:

1.  Send the data using the client associated to the RequesterConnection.

2.  Block until data is received or Timeout is met (in which case a null payload will be returned).

Building on the example of only sending data, in this scenario you add a new flow,
`socketSendQueryAndReceiveResult`, that connects to the Listener from the
`socketSearchDatabaseAndReturnResult` flow, send the query string, and wait for the response, which
is then written to a file:

```xml
	<sockets:listener-config name="Sockets_Listener_config" doc:name="Sockets Listener config" >
		<sockets:tcp-listener-connection host="localhost" port="8082" >
			<sockets:protocol >
				<sockets:direct-protocol />
			</sockets:protocol>
		</sockets:tcp-listener-connection>
	</sockets:listener-config>

	<sockets:listener-config name="Sockets_Listener_config1" doc:name="Sockets Listener config" >
		<sockets:tcp-listener-connection host="localhost" port="8085" >
			<sockets:protocol >
				<sockets:direct-protocol />
			</sockets:protocol>
		</sockets:tcp-listener-connection>
	</sockets:listener-config>

	<sockets:request-config name="Sockets_Request_config" doc:name="Sockets Request config" >
		<sockets:tcp-requester-connection host="localhost" port="8082" >
			<sockets:protocol >
				<sockets:direct-protocol />
			</sockets:protocol>
		</sockets:tcp-requester-connection>
	</sockets:request-config>

	<db:config name="Database_Config" doc:name="Database Config" >
		<db:oracle-connection host="localhost" user="sys as sysdba" password="Oradoc_db1" serviceName="orclpdb1.localdomain" />
	</db:config>

	<file:config name="File_Config" doc:name="File Config" >
		<file:connection />
	</file:config>

	<flow name="socket-testFlow">
		<sockets:listener doc:name="Listener" config-ref="Sockets_Listener_config" outputMimeType="application/json" />
		<db:select doc:name="Select" config-ref="Database_Config">
			<db:sql >#["SELECT first_name, last_name from SYSTEM.MUSICIANS where id = :id"]</db:sql>
			<db:input-parameters><![CDATA[#[{ 'id': payload.id }]]]></db:input-parameters>
		</db:select>
		<ee:transform doc:name="Transform Message">
			<ee:message >
				<ee:set-payload><![CDATA[%dw 2.0
					output application/json --- 'name': payload[0].FIRST_NAME as String ++ ' ' ++ payload[0].LAST_NAME as String]]>
				</ee:set-payload>
			</ee:message>
		</ee:transform>
	</flow>

	<flow name="socketSendAndReceive" >
		<sockets:listener doc:name="Listener" config-ref="Sockets_Listener_config1" outputMimeType="application/json"/>
		<sockets:send-and-receive doc:name="Send and receive" config-ref="Sockets_Request_config" outputMimeType="application/json">
		</sockets:send-and-receive>
		<logger level="INFO" doc:name="Logger" message='#[payload]'/>
		<file:write path="musicians.json" config-ref="File_Config" mode="CREATE_NEW" />
	</flow>
```

To test this example, use the same database setup as used for the sending example, run the Mule
application, access the endpoint using the following netcat command `nc localhost 8085`, and send
the data `{"id":2}`.

## Create a Custom TCP Protocol

The following example creates a TCP-based custom protocol that appends a string header to every
message sent and limits input message size to a fixed length by truncating all additional
characters.

1.  Create a class that implements the `TcpProtocol` interface:

```java
package org.mule.extension.socket.protocol;

import static java.lang.System.arraycopy;
import static org.slf4j.LoggerFactory.getLogger;

import org.apache.commons.io.output.ByteArrayOutputStream;
import org.mule.extension.socket.api.socket.tcp.TcpProtocol;
import org.slf4j.Logger;

import java.io.IOException;
import java.io.OutputStream;
import java.io.InputStream;
import java.io.ByteArrayInputStream;
import java.io.BufferedOutputStream;

public class CustomTestTcpProtocol implements TcpProtocol {

  protected static final int READ_ATTEMPTS = 50;
  protected static final int CUSTOM_BUFFER_SIZE = 30;
  private static final String HEADER = "This is my custom protocol.";
  private static final Logger LOGGER = getLogger(CustomTestTcpProtocol.class);

  protected int bufferSize;

  public CustomTestTcpProtocol() {
    this(CUSTOM_BUFFER_SIZE);
  }

  public CustomTestTcpProtocol(int bufferSize) {
    this.bufferSize = bufferSize;
  }

  @Override
  public InputStream read(InputStream socketIs) throws IOException {
    byte[] buffer = new byte[HEADER.length() + bufferSize];

    int bytesRead, attempts = 0;
    while ((bytesRead = socketIs.read(buffer)) <= 0 && (attempts < READ_ATTEMPTS)) {
      attempts++;
    }

    if (bytesRead <= 0) {
      throw new IOException("Number of read attempts exceeded! Failed to read any data from socket!");
    }

    ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream(bytesRead);
    byteArrayOutputStream.write(buffer, 0, bytesRead);
    return new ByteArrayInputStream(byteArrayOutputStream.toByteArray());
  }

  @Override
  public void write(OutputStream os, InputStream data) throws IOException {
    byte[] messageToSend = new byte[HEADER.length() + bufferSize];
    byte[] inputPayload = new byte[bufferSize];

    int dataLength = data.read(inputPayload);
    if (dataLength == bufferSize) {
      LOGGER.warn("Data length exceeds buffer size so data will be chunked.");
    }

    arraycopy(HEADER.getBytes(), 0, messageToSend, 0, HEADER.length());

    if (dataLength >= 0) {
      arraycopy(inputPayload, 0, messageToSend, HEADER.length(), dataLength);
    }

    BufferedOutputStream writer = new BufferedOutputStream(os);
		writer.write(messageToSend, 0, HEADER.length() + dataLength);
		writer.flush();
    }
  }
}
```

2.  Add the class name in the **Connector configuration** window of the Sockets Listener source and
    either the Sockets Send operation or Send and receive operation:

    - Sockets Listener source

      1.  In Studio, open the **Global Element Properties** configuration for your Sockets Listener
          source.

      2.  On the **General** tab, set **Protocol** to `Custom protocol`.

      3.  Add the class name in the **Protocol Class Name** field.

![Sockets Custom Protocol Configuration](/mulesoft/current/en-us/sockets-connector/latest/_images/socket-custom1-configuration.png)

Figure 1. Sockets Listener Custom Protocol Configuration

- Sockets Send operation or Send and receive operation

  1.  In Studio, open the **Global Element Properties** configuration of your Sockets Send operation
      or Send and receive operation.

  2.  On the **Connection** tab, set **Protocol** to `Custom protocol`.

  3.  Add the class name in the **Protocol Class Name** field.

![Sockets Send and Receive Custom Protocol Configuration](/mulesoft/current/en-us/sockets-connector/latest/_images/socket-custom2-configuration.png)

Figure 2. Sockets Send and Receive Custom Protocol Configuration

In the **Configuration XML** tab, use the `class` parameter to add the class in the
`sockets:custom-protocol` section of the connector operation:

```xml
<sockets:request-config name="SocketsRequestConfigCustomTcp" >
    <sockets:tcp-requester-connection host="127.0.0.1" port="${tcp.port}" failOnUnresolvedHost="true" sendTcpNoDelay="true">
        <sockets:protocol>
            <sockets:custom-protocol class="org.mule.extension.socket.protocol.CustomTestTcpProtocol"/>
        </sockets:protocol>
    </sockets:tcp-requester-connection>
</sockets:request-config>

<sockets:listener-config name="SocketsListenerConfigCustomTcp">
    <sockets:tcp-listener-connection host="127.0.0.1" port="${tcp.port}">
        <sockets:protocol>
            <sockets:custom-protocol class="org.mule.extension.socket.protocol.CustomTestTcpProtocol"/>
        </sockets:protocol>
    </sockets:tcp-listener-connection>
</sockets:listener-config>
```

## See Also

[Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)
[Salesforce Help](https://help.salesforce.com)

<!-- document id=2bb5f9cee2ef78e2e387ca4bf435e14ad4f42390f6871dbfa15d6111d5ec6c15 url=/mulesoft/current/en-us/sockets-connector/latest/sockets-connector-troubleshooting.md -->

---
product: Sockets Connector
version: 1.2
is-latest-version: true
---

# Troubleshooting Sockets Connector

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

To troubleshoot Anypoint Connector for Sockets (Sockets Connector), become familiar with the
information about enabling verbose logging and interpreting commonly thrown messages.

## Enable Verbose Logging

To get a better understanding of why an application’s interaction with the Sockets Connector is
failing, temporarily enable verbose logging for the connector.

Remember to always disable the enhanced verbosity after troubleshooting, because it affects your
Mule application performance.

To enable verbose logging in the configuration file:

1.  Access Anypoint Studio and navigate to the **Package Explorer** view.

2.  Open your application’s project name.

3.  Open the `src/main/resources` path folder.

4.  Open the `log4j2.xml` file inside the folder.

5.  Add an `<AsyncLogger>` tag inside the `<Loggers>` tag:

    ```xml
    			<Loggers>
    				...
    				<AsyncLogger name="org.mule.extension.socket" level="DEBUG"/>
    				...
    			</Loggers>
    ```

6.  Save your application changes.

7.  Click the project name in **Package Explorer** and then click **Run** > **Run As** > **Mule
    Application**.

## Understand Common Throws

Here is a list of common throw messages and how to interpret them:

- SOCKETS:UNKNOWN\_HOST

  Mule cannot determine the IP address of a host.

- SOCKETS:CONNECTIVITY

  The connection is no longer valid. Apply a reconnection policy if defined in the application
  setup.

- SOCKETS:CONNECTION\_TIMEOUT

  The attempt to connect to the Socket timed out.

- SOCKETS:RETRY\_EXHAUSTED

  The maximum number of retries for the operation is reached.

- SOCKETS:LENGTH\_EXCEEDED

  There was an attempt of reading or writing more bytes than the allowed limit.

## See Also

- [Sockets Connector Reference](https://docs.mulesoft.com/sockets-connector/latest/sockets-documentation)

- [Salesforce Help](https://help.salesforce.com)

- [Known Issues](https://help.salesforce.com/s/issues)

<!-- document id=6bdb1dab699f74d19785ef4a8db6d6cd30e38df7306cb44c16f9c650baf95a69 url=/mulesoft/current/en-us/sockets-connector/latest/sockets-connector-studio.md -->

---
product: Sockets Connector
version: 1.2
is-latest-version: true
---

# Using Anypoint Studio to Configure Sockets Connector 1.2

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and
configuration files.

To add and configure a connector in Studio:

1.  [Create a Mule project](#create-mule-project).

2.  [Add the connector to your Mule project](#add-connector-to-project).

3.  [Configure the Sockets Listener source for the connector’s flow](#configure-input-source).

4.  [Configure the Send and Receive operations in the flow](#add-connector-operation).

5.  [Configure supported TCP protocols](#configure-other-fields).

If you are new to configuring connectors in Studio, see
[Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio).
If, after reading this topic, you need additional information about the connector fields, see the
[Sockets Connector Reference](https://docs.mulesoft.com/sockets-connector/latest/sockets-documentation).

## Create a Mule Project

In Studio, create a new Mule project in which to add and configure the connector:

1.  In Studio, select **File > New > Mule Project**.

2.  Enter a name for your Mule project and click **Finish**.

## Add the Connector to Your Mule Project

Add Anypoint Connector for Sockets (Sockets Connector) to your Mule project to automatically
populate the XML code with the connector’s namespace and schema location and add the required
dependencies to the project’s `pom.xml` file:

1.  In the **Mule Palette** view, click **(X) Search in Exchange**.

2.  In the **Add Dependencies to Project** view, type `sockets` in the search field.

3.  Click **Sockets** in **Available modules**.

4.  Click **Add**.

5.  Click **Finish**.

Adding a connector to a Mule project in Studio does not make that connector available to other
projects in your Studio workspace.

## Configure the Sockets Listener Source

A source initiates a flow when a specified condition is met. The Sockets Listener source represents
a socket endpoint to which clients can connect. By browsing to this endpoint, external clients
establish a TCP or UDP socket connection and trigger the flow each time they send a message:

1.  In the **Mule Palette** view, select **Sockets** > **Listener**.

2.  Drag **Listener** to the Studio canvas.

3.  On the **Listener** configuration screen, optionally change the value of the **Display Name**
    field.

4.  Click the plus sign (+) next to the **Connector configuration** field to configure a global
    element that can be used by all instances of `sockets listener` in the app.

5.  On the **General** tab, for **Connection** select the `Tcp listener` or the `Udp listener`
    connections.

6.  Configure the specific tabs for the selected connection:

    <table><colgroup><col> <col></colgroup><thead><tr><th>Tab Name</th><th>Description</th></tr></thead><tbody><tr><td><p><strong>General</strong></p></td><td><p>Set the required <strong>Host</strong> and <strong>Port</strong> attributes and configure any other optional fields.</p></td></tr><tr><td><p><strong>Buffer Configuration</strong></p></td><td><p>Optionally specify send and receive buffer size information.</p></td></tr><tr><td><p><strong>TLS</strong></p></td><td><p>Optionally specify the TLS information.</p></td></tr><tr><td><p><strong>Timeout Configuration</strong></p></td><td><p>Optionally specify the client and server timeout information.</p></td></tr><tr><td><p><strong>Advanced</strong></p></td><td><p>Optionally specify the reconnection information, including a reconnection strategy.</p></td></tr></tbody></table>

7.  Click **Test Connection** to confirm that Mule can connect with the specific server.

8.  Click **OK**.

In Studio, the Sockets Listener source in the flow looks like this:

![Sockets Listener Source](/mulesoft/current/en-us/sockets-connector/latest/_images/socket-listener-source.png)

Figure 1. Sockets Listener Source

In Studio, configuring the Sockets Listener source with a TCP connection to accept local incoming
connections on port `8082` looks like this:

![Sockets Listener Source Configuration](/mulesoft/current/en-us/sockets-connector/latest/_images/socket-listener-configuration.png)

Figure 2. Sockets Listener Source Configuration

In the **Configuration XML** tab, the XML looks like this:

```xml
	<sockets:listener-config name="Sockets_Listener_config">
		<sockets:tcp-listener-connection host="localhost" port="8082" />
	</sockets:listener-config>

	<flow name="SocketsFlow" >
		<sockets:listene config-ref="Sockets_Listener_config"/>
	</flow>
```

## Configure the Send Operation and the Send and Receive Operation

When you add a connector operation to your flow, you immediately define a specific operation for
that connector to perform. Sockets Connector provides two basic operations:

- Send  
  Sends the data using the client associated to the RequesterConnection

- Send and receive  
  Sends the data using the associated client and then blocks until a response is received or the
  timeout is met, in which case the operation returns a null payload

To configure the Send operation or the Send and Receive operation:

1.  In the **Mule Palette** view, select either:

    - **Sockets** > **Send**

    - **Sockets** > **Send and receive**.

2.  Drag the **Send** or the **Send and receive** operation to the Studio canvas.

3.  On the operation configuration screen, optionally change the value of the **Display Name**
    field.

4.  Click the plus sign (+) next to the **Connector configuration** field to configure a global
    element that can be used by all instances of `Sockets Send` or `Sockets Send and receive` in the
    app.

5.  On the **General** tab, for **Connection** select the `Tcp requester` or the `Udp requester`
    connections.

6.  Configure the specific tabs for the selected connection:

    <table><colgroup><col> <col></colgroup><thead><tr><th>Tab Name</th><th>Description</th></tr></thead><tbody><tr><td><p><strong>General</strong></p></td><td><p>Set the required <strong>Host</strong> and <strong>Port</strong> attributes and configure optional fields as required.</p></td></tr><tr><td><p><strong>Buffer Configuration</strong></p></td><td><p>Optionally specify send and receive buffer size information.</p></td></tr><tr><td><p><strong>Connection</strong></p></td><td><p>Optionally select and configure one of the supported TCP protocols.</p></td></tr><tr><td><p><strong>Local Address Settings</strong></p></td><td><p>Optionally specify the local address.</p></td></tr><tr><td><p><strong>TLS</strong></p></td><td><p>Optionally specify the TLS information.</p></td></tr><tr><td><p><strong>Timeout Configuration</strong></p></td><td><p>Optionally specify the client and server timeout information.</p></td></tr><tr><td><p><strong>Advanced</strong></p></td><td><p>Optionally specify the reconnection information, including a reconnection strategy.</p></td></tr></tbody></table>

7.  Click **Test Connection** to confirm that Mule can connect with the specific server.

8.  Click **OK**.

Additionally, for the **Send and receive** operation, configure the MIME type as follows:

1.  Click the **Send and receive** operation from your flow.

2.  On the **MIME Type** tab, select a MIME type from field menu.

In Studio, the Sockets Send operation and Send and receive operation in the flow look like this:

![Sockets Send operation Send and Receive operation](/mulesoft/current/en-us/sockets-connector/latest/_images/socket-send-operation.png)

Figure 3. Sockets Send operation Send and Receive operation

In Studio, configuring either the Send operation or the Send and receive operation with a TCP
connection to accept local incoming connections on port `8082` looks like this:

![Sockets Send operation or Send and Receive operation configuration](/mulesoft/current/en-us/sockets-connector/latest/_images/socket-sendreceive-configuration.png)

Figure 4. Sockets Send operation or Send and Receive operation configuration

In the **Configuration XML** tab, the Send operation configuration XML looks like this:

```xml
<sockets:request-config name="Sockets_Send_config">
		<sockets:tcp-requester-connection host="localhost" port="8082" />
	</sockets:request-config>

	<flow name="SocketsFlow" >
		<sockets:send config-ref="Sockets_Send_config"/>
	</flow>
```

In Studio, configuring the MIME type as `application/json` for the Send and receive operation looks
like this:

![Sockets MIME type Configuration](/mulesoft/current/en-us/sockets-connector/latest/_images/socket-mimetype-configuration.png)

Figure 5. Sockets MIME Type Configuration

In the **Configuration XML** tab, the Send and receive operation configuration XML looks like this:

```xml
<sockets:request-config name="Sockets_Send_config">
	<sockets:tcp-requester-connection host="localhost" port="8082" />
</sockets:request-config>

<flow name="SocketsFlow" >
	<sockets:send-and-receive config-ref="Sockets_Send_Receive_config" outputMimeType="application/json"/>
</flow>
```

## Configure the Supported TCP Protocols

Sockets Connector supports application-level protocols implemented on top of TCP. You must implement
these protocols in both client and server ends so they can work properly.  
By default, the Sockets Connector implements the Safe Protocol; however, you can configure a
different protocol for the connector operations both in Anypoint Studio and XML.

Supported TCP protocols include the following:

- Direct Protocol  
  The socket reads until no more bytes are immediately available. On slow networks, `EOFProtocol`
  and `LengthProtocol` might be more reliable.

- EOF Protocol  
  Reading is terminated by the stream being closed by the client.

- Length Protocol  
  This protocol is defined by sending or reading an integer (the packet length) and then the data to
  transfer.

- Custom Class Loading Length Protocol  
  A length protocol that uses a specific class loader to load objects from streams.

- Safe Protocol  
  A test protocol that precedes every message with a cookie and which should not be used in
  production environments.

- Streaming Protocol  
  Allows the socket’s Send operation to return a message with the original `InputStream` as payload.

- XML Message Protocol  
  Use this protocol to read streaming XML documents. The only requirement is that each document
  includes an XML declaration at the beginning of the document in the form of `<?xml…​.`.  
  Data is read until a new document is found or until there is no more currently available data. For
  slower networks, `XmlMessageEofProtocol` might be more reliable.  
  Also, because the default character encoding for the platform is used to decode the message bytes
  when looking for the XML declaration, some caution with message character encodings is warranted.

- XML Message EOF Protocol  
  Extends `XmlMessageProtocol` to continue reading until either a new message or EOF is found.

- Custom Protocol  
  Define your own custom protocol by writing a class that extends `TcpProtocol`.

### Configure TCP Protocols for the Sockets Listener

To configure supported TCP protocols for the Sockets Listener:

1.  Open the **Global Element Properties** configuration of the Sockets Listener.

2.  On the **General** tab, for **Connection** select `Tcp listener`.

3.  In the **General** section of the **General** tab, for **Protocol** select one of the supported
    protocols.

4.  Set the required fields for the connector.

5.  Click **Test Connection** to confirm that Mule can connect with the specific server.

6.  Click **OK**.

In Studio, configuring the Sockets Listener to use Direct Protocol looks like this:

![Sockets Direct Protocol Configuration](/mulesoft/current/en-us/sockets-connector/latest/_images/socket-tcp1-configuration.png)

Figure 6. Sockets Direct Protocol Configuration

In the **Configuration XML** tab, the XML looks as follows:

```xml
	<sockets:listener-config name="Sockets_Listener_config" >
		<sockets:tcp-listener-connection host="localhost" port="8082" >
			<sockets:protocol>
				<sockets:direct-protocol />
			</sockets:protocol>
		</sockets:tcp-listener-connection>
	</sockets:listener-config>
```

### Configure TCP Protocols for Send and Receive Operations

To configure supported TCP protocols for either the Send operation or the Send and receive
operation:

1.  Open the **Global Element Properties** configuration of your Sockets operation.

2.  On the **General** tab, for **Connection** select `Tcp requester`.

3.  On the **Connection** tab, for **Protocol** select one of the supported protocols.

4.  Set the required fields for the connector.

5.  Click **Test Connection** to confirm that Mule can connect with the specific server.

6.  Click **OK**.

In Studio, configuring the Send operation to use Direct Protocol looks like this:

![Sockets Direct Protocol Configuration](/mulesoft/current/en-us/sockets-connector/latest/_images/socket-tcp2-configuration.png)

Figure 7. Sockets Direct Protocol Configuration

In the **Configuration XML** tab, the XML looks like this:

```xml
<sockets:request-config name="Sockets_Send_config" >
	<sockets:tcp-requester-connection >
		<sockets:protocol >
			<sockets:direct-protocol />
		</sockets:protocol>
	</sockets:tcp-requester-connection>
</sockets:request-config>
```

## View the App Log

To check for problems, you can view the app log:

- If you’re running the app from Anypoint Platform, the output is visible in the Anypoint Studio
  console window.

- If you’re running the app using Mule from the command line, the app log is visible in your OS
  console.

Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also view the
app log in the default location `MULE_HOME/logs/<app-name>.log`.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)

- [Sockets Connector Reference](https://docs.mulesoft.com/sockets-connector/latest/sockets-documentation)

- [Salesforce Help](https://help.salesforce.com)