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, the names of required properties appear in bold. Any other properties (not in bold) 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	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: true (will be evaluated using flow file attributes and variable registry)
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: true (will be evaluated using flow file attributes and variable registry)
WebSocket Endpoint Id	websocket-endpoint-id	${websocket.endpoint.id}	A NiFi Expression to retrieve the endpoint id of a WebSocket ControllerService. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
WebSocket Message Type	websocket-message-type	TEXT	The type of message content: TEXT or BINARY Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)

Relationships:

Name	Description
success	FlowFiles that are sent successfully to the destination are transferred to this relationship.
failure	FlowFiles that failed to send to the destination are transferred to this relationship.

Reads Attributes:

None specified.

Writes Attributes:

Name	Description
websocket.controller.service.id	WebSocket Controller Service id.
websocket.session.id	Established WebSocket session id.
websocket.endpoint.id	WebSocket endpoint id.
websocket.message.type	TEXT or BINARY.
websocket.local.address	WebSocket server address.
websocket.remote.address	WebSocket client address.
websocket.failure.detail	Detail of the failure.

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:

Resource	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.