de.ruedigermoeller.fastcast.config

Class FCConfigBuilder.TopicBuilder

java.lang.Object

de.ruedigermoeller.fastcast.config.FCConfigBuilder.TopicBuilder

Enclosing class:

FCConfigBuilder

public class FCConfigBuilder.TopicBuilder
extends Object

Constructor Summary

Constructors

Constructor and Description
FCConfigBuilder.TopicBuilder(String transportName)

Method Summary

Methods

Modifier and Type	Method and Description
FCConfigBuilder.TopicBuilder	datagramSize(int sizBytes) set datagram size on current transport.
FCConfigBuilder	end()
FCConfigBuilder.TopicBuilder	membership(String topicname, int topicId) add predefined FCMembership topic service.
FCConfigBuilder.TopicBuilder	setOpenCalls(int maxOpen, long timeoutMS)
FCConfigBuilder.TopicBuilder	setRequestRespOptions(int maxOpenRequests, int timeOutMillis) set's request respons options on last added topic.
FCConfigBuilder.TopicBuilder	setSendQueuePercentage(int percentageOfSendHistory)
FCConfigBuilder.TopicBuilder	topic(String topicname, int topicId) add a topic with default values (8Mb/second rate limit, 40Mb send history).
FCConfigBuilder.TopicBuilder	topic(String topicname, int topicId, int maxDatagramsPerSecond) add a topic
FCConfigBuilder.TopicBuilder	topic(String topicname, int topicId, int maxDatagramsPerSecond, int maxGCPauseSeconds) add a topic

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FCConfigBuilder.TopicBuilder

public FCConfigBuilder.TopicBuilder(String transportName)

Method Detail

topic

public FCConfigBuilder.TopicBuilder topic(String topicname,
                                 int topicId)

add a topic with default values (8Mb/second rate limit, 40Mb send history). You should consider using more parameterized methods below, cause defaults eat up unnecessary memory for low traffic topics and in case of low-pause garbage collectors, vice versa set a hard rate limit of 8MB/second which might be too low for high volume topics.

Parameters:

topicname - - name used to retrieve topic related stuff later on

topicId - - 0 .. FCDispatcher.MAX_NUM_TOPICS (256 currently)

Returns:

topic

public FCConfigBuilder.TopicBuilder topic(String topicname,
                                 int topicId,
                                 int maxDatagramsPerSecond)

add a topic

Parameters:

topicname - - name used to retrieve topic related stuff later on

topicId - - 0 .. FCDispatcher.MAX_NUM_TOPICS (256 currently)

maxDatagramsPerSecond - - a DataGram has a default size of 8k, so a value of 1000 sets 8MByte rate limit note that history size is by default 5*send rate

Returns:

topic

public FCConfigBuilder.TopicBuilder topic(String topicname,
                                 int topicId,
                                 int maxDatagramsPerSecond,
                                 int maxGCPauseSeconds)

add a topic

Parameters:

topicname - - name used to retrieve topic related stuff later on

topicId - - 0 .. FCDispatcher.MAX_NUM_TOPICS (256 currently)

maxDatagramsPerSecond - - a DataGram has a default size of 8k, so a value of 1000 sets 8MByte rate limit note that off heap history size is set to maxGCPauseSeconds * send rate. This consume a lot of memory in case you set up many topics with high throughput

maxGCPauseSeconds - - the maximum GC pause you expect from any receiver. Because the receiver misses packets in case of GC, each sender has to keep a send history spanning the maximum GC pause time, else the receivers might get dropped (unrecoverable packet loss).

Returns:

setOpenCalls

public FCConfigBuilder.TopicBuilder setOpenCalls(int maxOpen,
                                        long timeoutMS)

setSendQueuePercentage

public FCConfigBuilder.TopicBuilder setSendQueuePercentage(int percentageOfSendHistory)

setRequestRespOptions

public FCConfigBuilder.TopicBuilder setRequestRespOptions(int maxOpenRequests,
                                                 int timeOutMillis)

set's request respons options on last added topic. Note the more unresponded ('open') requests are allowed, the more memory is needed to map requestId's to your responding future. On the other hand, throughput depends on the maximum allowed open requests. Default is 10000

Parameters:

maxOpenRequests - - the number of concurrent unresponded requests. If this is exceeded, calling remote methods with result will block until new slots get avaiable either by timeout or incoming responses.

timeOutMillis - - time until waiting for a response is given up. Since FastCast provides 1:N request/responses one can receive several responses (in different thread is configured so). In case a receiver is not interested in further responses, it should call 'done' on the FCFutureResultHandler future object.

membership

public FCConfigBuilder.TopicBuilder membership(String topicname,
                                      int topicId)

add predefined FCMembership topic service. This can be used to find out about other nodes in the cluster, get notified of new/leaving nodes. Additionally this is required to use the clusterview gui.

Parameters:

topicname -

topicId -

Returns:

end

public FCConfigBuilder end()

datagramSize

public FCConfigBuilder.TopicBuilder datagramSize(int sizBytes)

set datagram size on current transport. Default is 8000, min = 4000 max = 32000

Parameters:

sizBytes -