Package org.springframework.data.gemfire.config.annotation

Annotation Interface EnableGatewayReceiver

@Target(TYPE) @Retention(RUNTIME) @Inherited @Documented @Import(GatewayReceiverConfiguration.class) public @interface EnableGatewayReceiver
The EnableGatewayReceiver annotation creates a GatewayReceiver within an Apache Geode or Pivotal GemFire peer Cache.
Since:
2.2.0
See Also:
  • Cache
  • GatewayReceiver
  • GatewayTransportFilter
  • Import

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    bindAddress
    The IP address or hostname that the GatewayReceiver communication socket will be bound to.
    int
    endPort
    The end port that GatewayReceiver will use when selecting a port to run on.
    String
    hostnameForSenders
    The hostname or IP Address that the GatewaySender will use to connect and communicate with the GatewayReceiver.
    boolean
    manualStart
    A boolean to allow the GatewayReceiver to be created without being started after creation.
    int
    maximumTimeBetweenPings
    An integer value in milliseconds representing the maximum time which a GatewayReceiver will wait to receive a ping back from a GatewaySender before the GatewayReceiver believes the sender to be not available.
    This property can also be configured using the spring.data.gemfire.gateway.receiver.maximum-time-between-pings property
    Default value is 60000
    int
    socketBufferSize
    The socket buffer size for the GatewayReceiver.
    int
    startPort
    The starting port that GatewayReceiver will use when selecting a port to run on.
    String[]
    transportFilters
    An in-order list of GatewayTransportFilter to be applied to GatewayReceiver
    This property can also be configured using the spring.data.gemfire.gateway.receiver.transport-filters property
    Default value is an empty String array

  • Element Details

    • bindAddress

      String bindAddress
      The IP address or hostname that the GatewayReceiver communication socket will be bound to. An empty String will cause the underlying socket to bind to 0.0.0.0
      This property can also be configured using the spring.data.gemfire.gateway.receiver.bind-address property
      Default value is ""
      Default:
      ""

    • hostnameForSenders

      String hostnameForSenders
      The hostname or IP Address that the GatewaySender will use to connect and communicate with the GatewayReceiver. An empty String will cause the system to expose the hostname to the GatewaySender. Generally this property is set when there are multiple network interfaces or when they are designated as "internal" or "public" network interfaces. In a cloud environment the notion of external and internal network interfaces exist and generally the "externally"/outwardly facing network interface is used.
      This property can also be configured using the spring.data.gemfire.gateway.receiver.hostname-for-senders property
      Default value is ""
      Default:
      ""

    • manualStart

      boolean manualStart
      A boolean to allow the GatewayReceiver to be created without being started after creation. If the manualStart is set to true then the system will create the GatewayReceiver but not start it. It then becomes the responsibility of the operator to start the GatewayReceiver at a later stage. If set to false the GatewayReceiver will start automatically after creation.
      This property can also be configured using the spring.data.gemfire.gateway.receiver.manual-start property
      Default is false
      Default:
      false

    • maximumTimeBetweenPings

      int maximumTimeBetweenPings
      An integer value in milliseconds representing the maximum time which a GatewayReceiver will wait to receive a ping back from a GatewaySender before the GatewayReceiver believes the sender to be not available.
      This property can also be configured using the spring.data.gemfire.gateway.receiver.maximum-time-between-pings property
      Default value is 60000
      Default:
      60000

    • startPort

      int startPort
      The starting port that GatewayReceiver will use when selecting a port to run on. This range of port numbers is bounded by a startPort and endPort.
      This property can also be configured using the spring.data.gemfire.gateway.receiver.start-port property
      Default is 5000
      Default:
      5000

    • endPort

      int endPort
      The end port that GatewayReceiver will use when selecting a port to run on. This range of port numbers is bounded by a startPort and endPort.
      This property can also be configured using the spring.data.gemfire.gateway.receiver.end-port property
      Default is 5500
      Default:
      5500

    • socketBufferSize

      int socketBufferSize
      The socket buffer size for the GatewayReceiver. This setting is in bytes.
      This property can also be configured using the spring.data.gemfire.gateway.receiver.socket-buffer-size property
      Default value is 524288
      Default:
      524288

    • transportFilters

      String[] transportFilters
      An in-order list of GatewayTransportFilter to be applied to GatewayReceiver
      This property can also be configured using the spring.data.gemfire.gateway.receiver.transport-filters property
      Default value is an empty String array
      Default:
      {}