PutWebSocket
Description
Sends messages to a WebSocket remote endpoint using a WebSocket session that is established by either ListenWebSocket or ConnectWebSocket.
Tags
WebSocket, publish, send
Properties
In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| WebSocket Session Id * | websocket-session-id | ${websocket.session.id} | A NiFi Expression to retrieve the session id. If not specified, a message will be sent to all connected WebSocket peers for the WebSocket controller service endpoint. Supports Expression Language, using FlowFile attributes and Environment variables. | |
| WebSocket ControllerService Id * | websocket-controller-service-id | ${websocket.controller.service.id} | A NiFi Expression to retrieve the id of a WebSocket ControllerService. Supports Expression Language, using FlowFile attributes and Environment variables. | |
| WebSocket Endpoint Id * | websocket-endpoint-id | ${websocket.endpoint.id} | A NiFi Expression to retrieve the endpoint id of a WebSocket ControllerService. Supports Expression Language, using FlowFile attributes and Environment variables. | |
| WebSocket Message Type * | websocket-message-type | TEXT | The type of message content: TEXT or BINARY Supports Expression Language, using FlowFile attributes and Environment variables. |
Dynamic Properties
This component does not support dynamic properties.
Relationships
| Name | Description |
|---|---|
| failure | FlowFiles that failed to send to the destination are transferred to this relationship. |
| success | FlowFiles that are sent successfully to the destination are transferred to this relationship. |
Reads Attributes
This processor does not read attributes.
Writes Attributes
| Name | Description |
|---|---|
| websocket.controller.service.id | WebSocket Controller Service id. |
| websocket.endpoint.id | WebSocket endpoint id. |
| websocket.failure.detail | Detail of the failure. |
| websocket.local.address | WebSocket server address. |
| websocket.message.type | TEXT or BINARY. |
| websocket.remote.address | WebSocket client address. |
| websocket.session.id | Established WebSocket session id. |
State Management
This component does not store state.
Restricted
This component is not restricted.
Input Requirement
This component requires an incoming relationship.
System Resource Considerations
| Scope | Description |
|---|---|
| MEMORY | An instance of this component can cause high usage of this system resource. Multiple instances or high concurrency settings may result a degradation of performance. |