From 885c54878ae6632ae96ae4ff2ccdb3b63e0f149d Mon Sep 17 00:00:00 2001 From: Rob Austin Date: Mon, 10 Nov 2014 17:39:56 +0000 Subject: [PATCH] updated docs --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index e3800f8d1..bbfb5e4f9 100644 --- a/README.md +++ b/README.md @@ -818,10 +818,10 @@ example of just two servers, they only have to be connected via a single tcp soc the data is transferred both ways. Which is great, however what if you wanted to replicate more than just one chronicle map, what if you were going to replicate two chronicle maps across your network, unfortunately with just TCP replication you would have to have two tcp socket connections, which is -not ideal. This is why we created the ReplicationHub. The ReplicationHub lets you replicate numerous +not ideal. This is why we created the `ReplicationHub`. The `ReplicationHub` lets you replicate numerous Chronicle Maps via a single point to point socket connection. -The ReplicationHub encompasses TCP replication, where each map has to be given a +The `ReplicationHub` encompasses TCP replication, where each map has to be given a unique identifier, but when using Chronicle Channels its the channels that are used to identify the map. The identifier is used to identify the host/server. Each host must be given a unique identifier. Each map must be given a unique Channel. @@ -829,7 +829,7 @@ Each map must be given a unique Channel. ``` java int maxEntrySize = 1024; byte identifier= 2; -ReplicationHub replicationHub = ReplicationHub.builder() +`ReplicationHub` replicationHub = `ReplicationHub`.builder() .maxEntrySize(maxEntrySize) .tcpTransportAndNetwork(tcpConfig) .createWithId(identifier); @@ -838,12 +838,12 @@ ReplicationHub replicationHub = ReplicationHub.builder() In this example above the channel is given the identifier of 2. In addition to specifying the identifier we also have to set the maximum entry size, this sets -the size of the memory buffers within the ReplicationChannel. This has to be set manually, with channels you -are able to attach additional maps to a ReplicationChannel once its up and running, so the maximum size of each +the size of the memory buffers within the `ReplicationChannel`. This has to be set manually, with channels you +are able to attach additional maps to a `ReplicationChannel` once its up and running, so the maximum size of each entry in the map can not be known in advance and we don’t currently support automatic resizing of buffers. -When creating the ReplicationChannel you should attach your tcp or udp configuration +When creating the `ReplicationChannel` you should attach your tcp or udp configuration ``` java int maxEntrySize = 1024; byte identifier = 1; @@ -853,7 +853,7 @@ ReplicationHub replicationHub = ReplicationHub.builder() .createWithId(identifier); ``` -Attaching ReplicationChannel replication to the map: +Attaching `ReplicationChannel` replication to the map: ``` java short channel = (short) 2; @@ -882,7 +882,7 @@ to replicate the wrong maps data. The chronicle channels don't have to be in ord unique for each map you have. -### Channels and ReplicationChannel - Example +### Channels and `ReplicationChannel` - Example ``` java // server 1 with identifier = 1