Package adams.flow.sink

Class Socket

  • All Implemented Interfaces:
    AdditionalInformationHandler, ClassCrossReference, CleanUpHandler, CrossReference, Destroyable, GlobalInfoSupporter, EncodingSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, Serializable, Comparable
    public class Socket
extends AbstractSink
implements EncodingSupporter, ClassCrossReference
    Just outputs the data to the specified socket.
    Any incoming data that isn't a byte array gets converted to a string and its bytes (using the specified encoding) are then transmitted.

    See also:
    adams.flow.source.Socket

    Input/output:
    - accepts:
       java.lang.Object
       byte[]
       java.lang.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: Socket
 
    -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
 
    -address <adams.core.base.BaseHostname> (property: address)
    The address to connect to.
    default: 127.0.0.1:8000
 
    -encoding <adams.core.base.BaseCharset> (property: encoding)
    The type of encoding for sending the data.
    default: Default
 
    -close-after-send <boolean> (property: closeAfterSend)
    If enabled, the socket will get closed after sending the data.
    default: true
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Address

        protected BaseHostname m_Address
        the address to open.

      • m_Encoding

        protected BaseCharset m_Encoding
        the encoding to use.

      • m_CloseAfterSend

        protected boolean m_CloseAfterSend
        whether to close the socket after sending data.

      • m_Socket

        protected transient Socket m_Socket
        the socket to use.

    • Constructor Detail

      • Socket

        public Socket()

    • Method Detail

      • setAddress

        public void setAddress​(BaseHostname value)
        Sets the address.
        Parameters:
        value - the address

      • getAddress

        public BaseHostname getAddress()
        Returns the address.
        Returns:
        the address

      • addressTipText

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

      • setEncoding

        public void setEncoding​(BaseCharset value)
        Sets the encoding to use.
        Specified by:
        setEncoding in interface EncodingSupporter
        Parameters:
        value - the encoding, e.g. "UTF-8" or "UTF-16", empty string for default

      • getEncoding

        public BaseCharset getEncoding()
        Returns the encoding to use.
        Specified by:
        getEncoding in interface EncodingSupporter
        Returns:
        the encoding, e.g. "UTF-8" or "UTF-16", empty string for default

      • encodingTipText

        public String encodingTipText()
        Returns the tip text for this property.
        Specified by:
        encodingTipText in interface EncodingSupporter
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setCloseAfterSend

        public void setCloseAfterSend​(boolean value)
        Sets whether to close the socket after sending the data.
        Parameters:
        value - true if to close socket

      • getCloseAfterSend

        public boolean getCloseAfterSend()
        Returns whether to close the socket after sending the data.
        Returns:
        true if to close socket

      • closeAfterSendTipText

        public String closeAfterSendTipText()
        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.
        Specified by:
        accepts in interface InputConsumer
        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