VMware GemFire Java API Reference
Package org.apache.geode.cache.wan
Interface GatewayReceiverFactory
public interface GatewayReceiverFactory
- Since:
- GemFire 7.0
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionDeprecated.for removal in a future release.create()Creates and returns an instance ofGatewayReceiverDeprecated.for removal in a future release.setBindAddress(String address) Sets the ip address or host name that thisGatewayReceiveris to listen on for GatewaySender ConnectionsetEndPort(int endPort) Sets the end port for the GatewayReceiver.setEventRetryAttempts(int eventRetryAttempts) Sets the number of retry attempts to apply failing events from remote GatewaySenders.setEventRetryInterval(long eventRetryInterval) Sets the wait time between retry attempts to apply failing events from remote GatewaySenderssetHostnameForSenders(String address) Sets the ip address or host name that server locators will tell GatewaySenders that this GatewayReceiver is listening on.setManualStart(boolean start) Sets the manual start boolean property for thisGatewayReceiver.setMaximumTimeBetweenPings(int time) Sets the maximum amount of time between client pings.The default is 60000 ms.setSocketBufferSize(int socketBufferSize) Sets the buffer size in bytes of the socket connection for thisGatewayReceiver.setStartPort(int startPort) Sets the start port for theGatewayReceiver.
-
Field Details
-
A_GATEWAY_RECEIVER_ALREADY_EXISTS_ON_THIS_MEMBER
- See Also:
-
-
Method Details
-
setStartPort
Sets the start port for theGatewayReceiver. If set the GatewayReceiver will start at one of the port between startPort and endPort. The default startPort 50505.- Parameters:
startPort- the start port for the GatewayReceiver- Returns:
- this factory
-
setEndPort
Sets the end port for the GatewayReceiver. If set the GatewayReceiver will start at one of the port between startPort and endPort. The default endPort 50605.- Parameters:
endPort- the end port for the GatewayReceiver- Returns:
- this factory
-
setSocketBufferSize
Sets the buffer size in bytes of the socket connection for thisGatewayReceiver. The default is 32768 bytes.- Parameters:
socketBufferSize- The size in bytes of the socket buffer- Returns:
- this factory
-
setBindAddress
Sets the ip address or host name that thisGatewayReceiveris to listen on for GatewaySender Connection- Parameters:
address- String representing ip address or host name- Returns:
- this factory
-
addGatewayTransportFilter
Deprecated.for removal in a future release. No replacement is planned.Adds aGatewayTransportFilter- Parameters:
filter- GatewayTransportFilter- Returns:
- this factory
-
removeGatewayTransportFilter
Deprecated.for removal in a future release. No replacement is planned.Removes aGatewayTransportFilter- Parameters:
filter- GatewayTransportFilter- Returns:
- this factory
-
setMaximumTimeBetweenPings
Sets the maximum amount of time between client pings.The default is 60000 ms.- Parameters:
time- The maximum amount of time between client pings- Returns:
- this factory
-
setHostnameForSenders
Sets the ip address or host name that server locators will tell GatewaySenders that this GatewayReceiver is listening on.- Parameters:
address- String representing ip address or host name- Returns:
- this factory
-
setManualStart
Sets the manual start boolean property for thisGatewayReceiver.- Parameters:
start- the manual start boolean property for thisGatewayReceiver- Returns:
- this factory
- Since:
- GemFire 8.1 Default is true i.e. the
GatewayReceiverwill not start automatically once created. Ideal default value should be false to match with GatewaySender counterpart. But to not to break the existing functionality default value is set to true. For next major releases, default value will be changed to false.
-
setEventRetryAttempts
Sets the number of retry attempts to apply failing events from remote GatewaySenders. When an event is being retried, processing of other events will be blocked until a successful retry, or until the number of retry attempts has been reached. After retrying all failing events from remote GatewaySenders, if there are still failing events, those events will be sent back to GatewaySenders and the GatewayEventFailureListener callbacks will be invoked on senders. Sets retry attempts to -1, if want to keep retrying until the event is processed successfully.- Parameters:
eventRetryAttempts- The retry attempts for the event- Returns:
- this factory
- Since:
- GemFire 10.2
-
setEventRetryInterval
Sets the wait time between retry attempts to apply failing events from remote GatewaySenders- Parameters:
eventRetryInterval- The wait time in milliseconds between retries- Returns:
- this factory
- Since:
- GemFire 10.2
-
create
GatewayReceiver create()Creates and returns an instance ofGatewayReceiver- Returns:
- instance of GatewayReceiver
-