Interface ITCPLateralCacheAttributes

All Superinterfaces:
AuxiliaryCacheAttributes, Cloneable, ILateralCacheAttributes, Serializable
All Known Implementing Classes:
TCPLateralCacheAttributes

This interface defines functions that are particular to the TCP Lateral Cache plugin. It extends the generic LateralCacheAttributes interface which in turn extends the AuxiliaryCache interface.
  • Method Details

    • setTcpServer

      void setTcpServer(String val)
      Sets the tcpServer attribute of the ILateralCacheAttributes object

      Parameters:
      val - The new tcpServer value
    • getTcpServer

      Gets the tcpServer attribute of the ILateralCacheAttributes object

      Returns:
      The tcpServer value
    • setTcpServers

      void setTcpServers(String val)
      Sets the tcpServers attribute of the ILateralCacheAttributes object

      Parameters:
      val - The new tcpServers value
    • getTcpServers

      Gets the tcpServers attribute of the ILateralCacheAttributes object

      Returns:
      The tcpServers value
    • setTcpListenerPort

      void setTcpListenerPort(int val)
      Sets the tcpListenerPort attribute of the ILateralCacheAttributes object

      Parameters:
      val - The new tcpListenerPort value
    • getTcpListenerPort

      Gets the tcpListenerPort attribute of the ILateralCacheAttributes object

      Returns:
      The tcpListenerPort value
    • setTcpListenerHost

      Sets the tcpListenerHost attribute of the ILateralCacheAttributes object

      Parameters:
      val - The new tcpListenerHost value
    • getTcpListenerHost

      Gets the tcpListenerHost attribute of the ILateralCacheAttributes object

      Returns:
      The tcpListenerHost value
    • setUdpDiscoveryEnabled

      void setUdpDiscoveryEnabled(boolean udpDiscoveryEnabled)
      Can setup UDP Discovery. This only works for TCp laterals right now. It allows TCP laterals to find each other by broadcasting to a multicast port.

      Parameters:
      udpDiscoveryEnabled - The udpDiscoveryEnabled to set.
    • isUdpDiscoveryEnabled

      Whether or not TCP laterals can try to find each other by multicast communication.

      Returns:
      Returns the udpDiscoveryEnabled.
    • getUdpDiscoveryPort

      The port to use if UDPDiscovery is enabled.

      Returns:
      Returns the udpDiscoveryPort.
    • setUdpDiscoveryPort

      void setUdpDiscoveryPort(int udpDiscoveryPort)
      Sets the port to use if UDPDiscovery is enabled.

      Parameters:
      udpDiscoveryPort - The udpDiscoveryPort to set.
    • getUdpDiscoveryAddr

      The address to broadcast to if UDPDiscovery is enabled.

      Returns:
      Returns the udpDiscoveryAddr.
    • setUdpDiscoveryAddr

      void setUdpDiscoveryAddr(String udpDiscoveryAddr)
      Sets the address to broadcast to if UDPDiscovery is enabled.

      Parameters:
      udpDiscoveryAddr - The udpDiscoveryAddr to set.
    • getUdpTTL

      int getUdpTTL()
      The time-to-live for the UDP multicast packets

      Returns:
      Returns the udpTTL.
      Since:
      3.1
    • setUdpTTL

      void setUdpTTL(int udpTTL)
      Sets the time-to-live for the UDP multicast packet

      Parameters:
      udpTTL - The udpTTL to set.
      Since:
      3.1
    • setAllowGet

      void setAllowGet(boolean allowGet)
      Is the lateral allowed to try and get from other laterals.

      This replaces the old putOnlyMode

      Parameters:
      allowGet -
    • isAllowGet

      boolean isAllowGet()
      Is the lateral allowed to try and get from other laterals.

      Returns:
      true if the lateral will try to get
    • setAllowPut

      void setAllowPut(boolean allowPut)
      Is the lateral allowed to put objects to other laterals.

      Parameters:
      allowPut -
    • isAllowPut

      boolean isAllowPut()
      Is the lateral allowed to put objects to other laterals.

      Returns:
      true if puts are allowed
    • setIssueRemoveOnPut

      void setIssueRemoveOnPut(boolean issueRemoveOnPut)
      Should the client send a remove command rather than a put when update is called. This is a client option, not a receiver option. This allows you to prevent the lateral from serializing objects.

      Parameters:
      issueRemoveOnPut -
    • isIssueRemoveOnPut

      Should the client send a remove command rather than a put when update is called. This is a client option, not a receiver option. This allows you to prevent the lateral from serializing objects.

      Returns:
      true if updates will result in a remove command being sent.
    • isFilterRemoveByHashCode

      Should the receiver try to match hash codes. If true, the receiver will see if the client supplied a hash code. If it did, then it will try to get the item locally. If the item exists, then it will compare the hash code. if they are the same, it will not remove. This isn't perfect since different objects can have the same hash code, but it is unlikely of objects of the same type.

      Returns:
      boolean
    • setFilterRemoveByHashCode

      void setFilterRemoveByHashCode(boolean filter)
      Should the receiver try to match hash codes. If true, the receiver will see if the client supplied a hash code. If it did, then it will try to get the item locally. If the item exists, then it will compare the hash code. if they are the same, it will not remove. This isn't perfect since different objects can have the same hash code, but it is unlikely of objects of the same type.

      Parameters:
      filter -
    • setSocketTimeOut

      void setSocketTimeOut(int socketTimeOut)
      Parameters:
      socketTimeOut - the socketTimeOut to set
    • getSocketTimeOut

      Returns:
      the socketTimeOut
    • setOpenTimeOut

      void setOpenTimeOut(int openTimeOut)
      Parameters:
      openTimeOut - the openTimeOut to set
    • getOpenTimeOut

      Returns:
      the openTimeOut