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.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.commons.jcs3.auxiliary.lateral.behavior.ILateralCacheAttributes
ILateralCacheAttributes.Type
-
Field Summary
Fields inherited from interface org.apache.commons.jcs3.auxiliary.lateral.behavior.ILateralCacheAttributes
DEFAULT_ZOMBIE_QUEUE_MAX_SIZE
-
Method Summary
Modifier and TypeMethodDescriptionint
int
Gets the tcpListenerHost attribute of the ILateralCacheAttributes objectint
Gets the tcpListenerPort attribute of the ILateralCacheAttributes objectGets the tcpServer attribute of the ILateralCacheAttributes objectGets the tcpServers attribute of the ILateralCacheAttributes objectThe address to broadcast to if UDPDiscovery is enabled.int
The port to use if UDPDiscovery is enabled.int
The time-to-live for the UDP multicast packetsboolean
Is the lateral allowed to try and get from other laterals.boolean
Is the lateral allowed to put objects to other laterals.boolean
Should the receiver try to match hash codes.boolean
Should the client send a remove command rather than a put when update is called.boolean
Whether or not TCP laterals can try to find each other by multicast communication.void
setAllowGet
(boolean allowGet) Is the lateral allowed to try and get from other laterals.void
setAllowPut
(boolean allowPut) Is the lateral allowed to put objects to other laterals.void
setFilterRemoveByHashCode
(boolean filter) Should the receiver try to match hash codes.void
setIssueRemoveOnPut
(boolean issueRemoveOnPut) Should the client send a remove command rather than a put when update is called.void
setOpenTimeOut
(int openTimeOut) void
setSocketTimeOut
(int socketTimeOut) void
setTcpListenerHost
(String val) Sets the tcpListenerHost attribute of the ILateralCacheAttributes objectvoid
setTcpListenerPort
(int val) Sets the tcpListenerPort attribute of the ILateralCacheAttributes objectvoid
setTcpServer
(String val) Sets the tcpServer attribute of the ILateralCacheAttributes objectvoid
setTcpServers
(String val) Sets the tcpServers attribute of the ILateralCacheAttributes objectvoid
setUdpDiscoveryAddr
(String udpDiscoveryAddr) Sets the address to broadcast to if UDPDiscovery is enabled.void
setUdpDiscoveryEnabled
(boolean udpDiscoveryEnabled) Can setup UDP Discovery.void
setUdpDiscoveryPort
(int udpDiscoveryPort) Sets the port to use if UDPDiscovery is enabled.void
setUdpTTL
(int udpTTL) Sets the time-to-live for the UDP multicast packetMethods inherited from interface org.apache.commons.jcs3.auxiliary.AuxiliaryCacheAttributes
clone, getCacheName, getEventQueuePoolName, getEventQueueType, getName, setCacheName, setEventQueuePoolName, setEventQueueType, setName
Methods inherited from interface org.apache.commons.jcs3.auxiliary.lateral.behavior.ILateralCacheAttributes
getHttpListenerPort, getHttpServer, getHttpServers, getPutOnlyMode, getTransmissionType, getTransmissionTypeName, getUdpMulticastAddr, getUdpMulticastPort, getZombieQueueMaxSize, isReceive, setHttpListenerPort, setHttpServer, setHttpServers, setPutOnlyMode, setReceive, setTransmissionType, setTransmissionTypeName, setUdpMulticastAddr, setUdpMulticastPort, setZombieQueueMaxSize
-
Method Details
-
setTcpServer
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
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
Sets the tcpListenerPort attribute of the ILateralCacheAttributes object- Parameters:
val
- The new tcpListenerPort value
-
getTcpListenerPort
int 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
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
boolean isUdpDiscoveryEnabled()Whether or not TCP laterals can try to find each other by multicast communication.- Returns:
- Returns the udpDiscoveryEnabled.
-
getUdpDiscoveryPort
int getUdpDiscoveryPort()The port to use if UDPDiscovery is enabled.- Returns:
- Returns the udpDiscoveryPort.
-
setUdpDiscoveryPort
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
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
Sets the time-to-live for the UDP multicast packet- Parameters:
udpTTL
- The udpTTL to set.- Since:
- 3.1
-
setAllowGet
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
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
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
boolean 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
boolean 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
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
- Parameters:
socketTimeOut
- the socketTimeOut to set
-
getSocketTimeOut
int getSocketTimeOut()- Returns:
- the socketTimeOut
-
setOpenTimeOut
- Parameters:
openTimeOut
- the openTimeOut to set
-
getOpenTimeOut
int getOpenTimeOut()- Returns:
- the openTimeOut
-