de.ruedigermoeller.fastcast.config

Class FCConfigBuilder

java.lang.Object

de.ruedigermoeller.fastcast.config.FCConfigBuilder

public class FCConfigBuilder
extends Object

Created with IntelliJ IDEA. User: ruedi Date: 10/13/13 Time: 12:38 AM A helper class to build up cluster configurations programmatically. This is useful for uncritical small applications e.g. simple one publisher-many receiver or 1:1 local interprocess communication. Note that it is possible to generate a config file from a configbuilder (however this will be formatted ugly and also redefine all default values). Warning 1: for larger, performance critical clusters it is strongly recommended to use config files. Warning 2: all cluster nodes should share identical configurations, else you might experience communication chaos. Better create some static method initializing a cluster conf, which is used by all nodes of your cluster.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	FCConfigBuilder.TopicBuilder

Constructor Summary

Constructors

Constructor and Description
FCConfigBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
FCClusterConfig	build() compiles a FastCast cluster configuration object from the current state
FCConfigBuilder	loglevel(int levelFCLog)
static FCConfigBuilder	New()
FCConfigBuilder.TopicBuilder	sharedMemTransport(String transportName, File file) initialize a shared memory transport with shared memory residing in mmapped file given
FCConfigBuilder.TopicBuilder	sharedMemTransport(String transportName, File file, int sizeMByte, int packetSizeBytes) initialize a shared memory transport with shared memory residing in mmapped file given.
FCConfigBuilder.TopicBuilder	socketTransport(String transportName, String networkIface, String multicastIp, int multicastPort) initialize a transport with given name with given network adapter, multicast ip and multicast port.

Methods inherited from class java.lang.Object

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

Constructor Detail

FCConfigBuilder

public FCConfigBuilder()

Method Detail

New

public static FCConfigBuilder New()

loglevel

public FCConfigBuilder loglevel(int levelFCLog)

socketTransport

public FCConfigBuilder.TopicBuilder socketTransport(String transportName,
                                           String networkIface,
                                           String multicastIp,
                                           int multicastPort)

initialize a transport with given name with given network adapter, multicast ip and multicast port. note only ip 4 is supported (use -Djava.net.preferIPv4Stack=true in case). The ip's identifying a network adapter can be found on windows with 'ipconfig' under linux with 'ifconfig'. Note that under Linux one can use symbolic names such as 'eth0' or 'bond0'. This does not work always with windows.

Parameters:

transportName -

networkIface - - network adapter ip as told by ipconfig (win) or ifconfig (linux). Under linux on can also use the symbolic name given (e.g. 'lo', 'eth0', 'bond0'. Not that FCClusterConfig provides a method to introduce another level of indirection by adding 'name' to interface ip symbolic interface names

multicastIp -

multicastPort -

sharedMemTransport

public FCConfigBuilder.TopicBuilder sharedMemTransport(String transportName,
                                              File file)

initialize a shared memory transport with shared memory residing in mmapped file given

Parameters:

transportName -

file -

sharedMemTransport

public FCConfigBuilder.TopicBuilder sharedMemTransport(String transportName,
                                              File file,
                                              int sizeMByte,
                                              int packetSizeBytes)

initialize a shared memory transport with shared memory residing in mmapped file given. Size of file should be at least 50MB (default is 200MB). packetSize should vary from 4000 (lower throupghput, but possibly lower latency) to 32000 (higher throughput). Best throughput is machine/OS dependent. 16000 to 24000 is a good shot most of the time.

Parameters:

transportName -

file -

build

public FCClusterConfig build()

compiles a FastCast cluster configuration object from the current state

Returns: