Class TransactionCommProps

  • All Implemented Interfaces:
    EventListener, IGProp<GProp<?>[]>, IPropCnr, java.lang.Cloneable

    public class TransactionCommProps
    extends WebSocketCommProps
    This property container contains all properties required for Transaction communication based on WebSockets.
    Author:
    Christopher Mindus
    • Constructor Detail

      • TransactionCommProps

        protected TransactionCommProps()
        Creates the Transaction communication property container without a name. The name must be set in all cases using the setPropertyAtom call.
      • TransactionCommProps

        public TransactionCommProps​(Atom propertyAtom)
        Creates the Transaction communication property container with the specified name. All system-reserved names for components begins with "$".
        Parameters:
        propertyAtom - the name of the component, unique within it's parent.
    • Method Detail

      • setCacheParams

        public void setCacheParams​(int minLength,
                                   int maxLength,
                                   int count)
        Sets the parameters for cache: minLength, maxLength, count.
        Parameters:
        minLength - The minimum length for caching, 7 is the smallest value.
        maxLength - The maximum length for caching, normally 80 or so (maximum 1024).
        count - The count should normally be larger than 200 and smaller than 1000 (maximum 2048), if zero, cache is disabled.
        Throws:
        java.lang.IllegalArgumentException - If arguments are not valid.
      • getCacheParams

        public int[] getCacheParams()
        Gets the cache parameters as 3 integers in an array, param[0] is minLength, param[1] is maxLength, param[2] is count.

        The default values are minLength=7, maxLength=80, count=700 if nothing is specified.

        Returns:
        Array of 3 integer parameters, param[0] is minLength, param[1] is maxLength, param[2] is count.