Receives WebSocket messages from the specified WebSocket server. Produces a feature each time a message is received, and places the contents of the message into the specified attribute. Each incoming feature will cause the WebSocketReceiver to initialize a connection to the specified WebSocket server. The transformer will block while it waits to receive WebSocket messages until the remote host closes the connection.
The performance of this transformer is dependent on the amount of memory allocated to the Java Virtual Machine (JVM). The following environment variables allow you to specify memory available to Java Plugins:
- FME_JVM_MIN_HEAP_SIZE: Initial heap size for initializing the JVM. If unset, the default value is 1024K.
- FME32_JVM_MIN_HEAP_SIZE: Same as FME_JVM_MIN_HEAP_SIZE, but applies to 32-bit FME Desktop on Windows, and if set, takes precedence over FME_JVM_MIN_HEAP_SIZE.
These variables must be set in multiples of 1024 and greater than 1 MB. To indicate kilobytes, megabytes, or gigabytes, append k or K, m or M, or g or G respectively. For example, any of these values is acceptable:
- FME_JVM_MAX_HEAP_SIZE: Maximum heap size for initializing the JVM. If unset, the default value is 16384K.
- FME32_JVM_MAX_HEAP_SIZE: Same as FME_JVM_MAX_HEAP_SIZE, but applies to 32-bit FME Desktop on Windows, and if set, takes precedence over FME_JVM_MAX_HEAP_SIZE.
These variables must be set in multiples of 1024 and greater than 2 MB. To indicate kilobytes, megabytes, or gigabytes, append k or K, m or M, or g or G respectively. For example, any of these values is acceptable:
Note: To pass additional parameters used by FME to the Java Virtual Machine, use the JAVA_TOOL_OPTIONS environment variable.
This transformer accepts any feature.
Features containing the data that has been received from the specified WebSocket server.
The URL of the remote WebSocket server that the WebSocketReceiver will connect to in order to receive WebSocket messages. The default value is ws://localhost:7078. To initiate a secure connection to a WebSocket server using TLS, specify wss://<hostname>:<port>.
If Yes is specified, either explicitly or through a parameter, the WebSocketReceiver verifies the certificate (or chain of certificates) of the WebSocket server before establishing a connection.
If this optional parameter has a value, then the WebSocketReceiver will transmit the contents of this parameter to the remote WebSocket server before processing any incoming data.
To connect to the FME Server WebSocket server, use the following preamble:
"ws_op" : "open",
"ws_stream_ids" : ["<STREAMID>", "<STREAMID>", "<STREAMID>", ...]
To specify this preamble, click the ellipsis (...) to open the Connection Preamble dialog. Under FME Server WebSocket Preambles, select the Open Public Stream template. Then, specify a ws_stream_ids value.
ws_stream_ids identifies one or more message streams in order for the WebSocket server to associate them with the correct requesting application.
Specify the output attribute that will store the received WebSocket message data.
Editing Transformer Parameters
Using a set of menu options, transformer parameters can be assigned by referencing other elements in the workspace. More advanced functions, such as an advanced editor and an arithmetic editor, are also available in some transformers. To access a menu of these options, click beside the applicable parameter. For more information, see Transformer Parameter Menu Options.
FME Licensing Level
FME Professional edition and above
The FME Community is the place for demos, how-tos, articles, FAQs, and more. Get answers to your questions, learn from other users, and suggest, vote, and comment on new features.
Search for samples and information about this transformer on the FME Community.