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
- Author:
- Udo Kohlmeyer
- See Also:
-
Optional Element Summary
Modifier and TypeOptional ElementDescriptionThe IP address or hostname that theGatewayReceiver
communication socket will be bound to.int
The end port that GatewayReceiver will use when selecting a port to run on.The hostname or IP Address that theGatewaySender
will use to connect and communicate with theGatewayReceiver
.boolean
A boolean to allow the GatewayReceiver to be created without being started after creation.int
An integer value in milliseconds representing the maximum time which aGatewayReceiver
will wait to receive a ping back from aGatewaySender
before theGatewayReceiver
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 60000int
The socket buffer size for theGatewayReceiver
.int
The starting port that GatewayReceiver will use when selecting a port to run on.String[]
An in-order list ofGatewayTransportFilter
to be applied toGatewayReceiver
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 bindAddressThe IP address or hostname that theGatewayReceiver
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 hostnameForSendersThe hostname or IP Address that theGatewaySender
will use to connect and communicate with theGatewayReceiver
. An empty String will cause the system to expose the hostname to theGatewaySender
. 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 manualStartA 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 maximumTimeBetweenPingsAn integer value in milliseconds representing the maximum time which aGatewayReceiver
will wait to receive a ping back from aGatewaySender
before theGatewayReceiver
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 startPortThe 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 endPortThe 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 socketBufferSizeThe socket buffer size for theGatewayReceiver
. 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[] transportFiltersAn in-order list ofGatewayTransportFilter
to be applied toGatewayReceiver
This property can also be configured using the spring.data.gemfire.gateway.receiver.transport-filters property
Default value is an empty String array- Default:
- {}
-