Package adams.flow.sink

Class WebSocketClient

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, Serializable, Comparable
    public class WebSocketClient
extends AbstractSink
    Sends the incoming data to a websocket server and forwards the received data.

    Input/output:
    - accepts:
       java.lang.String
       byte[]


    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: WebSocketClient
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default: 
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow execution at this level gets stopped in case this 
    actor encounters an error; the error gets propagated; useful for critical 
    actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing 
    actor handler must have this enabled as well.
    default: false
 
    -generator <adams.flow.websocket.client.AbstractWebSocketClientGenerator> (property: generator)
    The client generator to use.
    default: adams.flow.websocket.client.SimpleSendGenerator
 
    -disconnect <boolean> (property: disconnect)
    If enabled, the connection will get closed immediately after sending the 
    data.
    default: false
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Client

        protected transient com.pusher.java_websocket.client.WebSocketClient m_Client
        the client instance.

      • m_Disconnect

        protected boolean m_Disconnect
        whether to disconnect immediately.

    • Constructor Detail

      • WebSocketClient

        public WebSocketClient()

    • Method Detail

      • reset

        protected void reset()
        Resets the scheme.
        Overrides:
        reset in class AbstractActor

      • setGenerator

        public void setGenerator​(WebSocketClientGenerator value)
        Sets the client generator to use.
        Parameters:
        value - the generator

      • getGenerator

        public WebSocketClientGenerator getGenerator()
        Returns the client generator to use
        Returns:
        the generator

      • generatorTipText

        public String generatorTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setDisconnect

        public void setDisconnect​(boolean value)
        Sets whether to immediately disconnect after sending the data.
        Parameters:
        value - true if to disconnect immediately

      • getDisconnect

        public boolean getDisconnect()
        Returns whether to immediately disconnect after sending the data.
        Returns:
        true if to disconnect immediately

      • disconnectTipText

        public String disconnectTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Returns:
        the Class of objects that can be processed

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message

      • wrapUp

        public void wrapUp()
        Cleans up after the execution has finished.
        Specified by:
        wrapUp in interface Actor
        Overrides:
        wrapUp in class AbstractSink