DATAGEODE-168 - Add documentation for GatewayReceiver annotation configuration support.
Resolves gh-7.
This commit is contained in:
@@ -625,3 +625,31 @@ See {sdg-javadoc}/org/springframework/data/gemfire/config/annotation/EnableConti
|
||||
See {sdg-javadoc}/org/springframework/data/gemfire/listener/annotation/ContinuousQuery.html[`@ContinuousQuery` Javadoc].
|
||||
|
||||
See <<apis:continuous-query>> and <<bootstrap-annotation-config-continuous-queries>> for more details.
|
||||
|
||||
[[bootstap-annotations-quickstart-gatewayreceiver]]
|
||||
== Configure Gateway Receivers
|
||||
|
||||
The replication of data between different {data-store-name} clusters is an increasingly important fault-tolerance and high availability mechanism.
|
||||
{data-store-name} WAN Replication is a mechanism that allows one {data-store-name} cluster to replicate its data to another
|
||||
{data-store-name} cluster in a reliable, fault-tolerant manner.
|
||||
|
||||
{data-store-name} WAN replication requires two components to be configured:
|
||||
* Gateway Receiver - The WAN replication component that receives data from a remote {data-store-name} cluster's Gateway Sender
|
||||
* Gateway Senders - The WAN replication component that sends data to a remote {data-store-name} cluster's Gateway Receiver
|
||||
|
||||
To enable a Gateway Receiver the application class needs to be annotated with `@EnableGatewayReceiver` as follows:
|
||||
[source,java]
|
||||
----
|
||||
@Configuration
|
||||
@CacheServerApplication
|
||||
@EnableGatewayReceiver(manualStart = false, startPort = 10000, endPort = 11000, maximumTimeBetweenPings = 1000,
|
||||
socketBufferSize = 16384, bindAddress = "localhost",transportFilters = {"transportBean1", "transportBean2"},
|
||||
hostnameForSenders = "hostnameLocalhost"){
|
||||
...
|
||||
...
|
||||
}
|
||||
}
|
||||
----
|
||||
NOTE: {data-store-name} is a server-side feature only and can only be configured on a CacheServer or PeerServer
|
||||
|
||||
See {sdg-javadoc}/org/springframework/data/gemfire/wan/annotation/EnableGatewayReceiver.html[`@EnableGatewayReceiver` Javadoc].
|
||||
@@ -342,6 +342,7 @@ configuration metadata at runtime, before the Spring managed beans that the anno
|
||||
* `PeerCacheConfigurer`
|
||||
* `PoolConfigurer`
|
||||
* `RegionConfigurer`
|
||||
* `EnableGatewayReceiverConfigurer`
|
||||
|
||||
For example, you can use the `CacheServerConfigurer` and `ClientCacheConfigurer` to customize the port numbers
|
||||
used by your Spring Boot `CacheServer` and `ClientCache` applications, respectively.
|
||||
|
||||
Reference in New Issue
Block a user