Interface GatewayReceiverFactory


public interface GatewayReceiverFactory
Since:
GemFire 7.0
  • Field Details

    • A_GATEWAY_RECEIVER_ALREADY_EXISTS_ON_THIS_MEMBER

      static final String A_GATEWAY_RECEIVER_ALREADY_EXISTS_ON_THIS_MEMBER
      See Also:
  • Method Details

    • setStartPort

      GatewayReceiverFactory setStartPort(int startPort)
      Sets the start port for the GatewayReceiver. 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

      GatewayReceiverFactory setEndPort(int endPort)
      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

      GatewayReceiverFactory setSocketBufferSize(int socketBufferSize)
      Sets the buffer size in bytes of the socket connection for this GatewayReceiver. The default is 32768 bytes.
      Parameters:
      socketBufferSize - The size in bytes of the socket buffer
      Returns:
      this factory
    • setBindAddress

      GatewayReceiverFactory setBindAddress(String address)
      Sets the ip address or host name that this GatewayReceiver is to listen on for GatewaySender Connection
      Parameters:
      address - String representing ip address or host name
      Returns:
      this factory
    • addGatewayTransportFilter

      @Deprecated GatewayReceiverFactory addGatewayTransportFilter(GatewayTransportFilter filter)
      Deprecated.
      for removal in a future release. No replacement is planned.
      Adds a GatewayTransportFilter
      Parameters:
      filter - GatewayTransportFilter
      Returns:
      this factory
    • removeGatewayTransportFilter

      @Deprecated GatewayReceiverFactory removeGatewayTransportFilter(GatewayTransportFilter filter)
      Deprecated.
      for removal in a future release. No replacement is planned.
      Removes a GatewayTransportFilter
      Parameters:
      filter - GatewayTransportFilter
      Returns:
      this factory
    • setMaximumTimeBetweenPings

      GatewayReceiverFactory setMaximumTimeBetweenPings(int time)
      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

      GatewayReceiverFactory setHostnameForSenders(String address)
      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

      GatewayReceiverFactory setManualStart(boolean start)
      Sets the manual start boolean property for this GatewayReceiver.
      Parameters:
      start - the manual start boolean property for this GatewayReceiver
      Returns:
      this factory
      Since:
      GemFire 8.1 Default is true i.e. the GatewayReceiver will 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

      GatewayReceiverFactory setEventRetryAttempts(int eventRetryAttempts)
      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

      GatewayReceiverFactory setEventRetryInterval(long eventRetryInterval)
      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 of GatewayReceiver
      Returns:
      instance of GatewayReceiver