de.ruedigermoeller.fastcast.remoting

Interface FCRemoting

All Known Implementing Classes:

FastCast

public interface FCRemoting

Created with IntelliJ IDEA. User: ruedi Date: 23.08.13 Time: 01:42 To change this template use File | Settings | File Templates.

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getActiveTopics()
FCMembership	getMemberShipLocal()
FCMembership	getMemberShipRemoteProxy() returns remote FCMemberShip instance, null if none installed
String	getNodeId()
FCRemoteServiceProxy	getRemoteService(String topic) return the remote service proxy object.
FCRemotingListener	getRemotingListener()
FCTopicService	getService(String topic) return the local instance of a service with given name.
TopicStats	getStats(String name)
FCTopicConf	getTopicConfiguration(String name)
void	joinCluster(FCClusterConfig config, String nodeId, String clusterName)
void	joinCluster(String configPath, String nodeId, String clusterName) joins the cluster defined by the given config.
void	setRemotingListener(FCRemotingListener listener)
void	start(String serviceName)
void	startReceiving(String topicName, FCBinaryMessageListener listener) starts listening on the given topic
void	startReceiving(String topicName, FCTopicService listener)
<T extends FCTopicService> T	startSending(String topic, Class<T> fcBinaryTopicServiceClass) starts sending on the given topic use this for ConfigBuilder based configs.
void	stopReceiving(String topicName)

Method Detail

getNodeId

String getNodeId()

Returns:

cluster-unique nodeid associated with this process. Avaiable after joinCluster !

getService

FCTopicService getService(String topic)

return the local instance of a service with given name. via getService(name).getProxy() the Remote Proxy can be obtained to send messages to remote instances. The service is present only if startReceiving has been called on the associated topic

Parameters:

topic -

Returns:

getRemoteService

FCRemoteServiceProxy getRemoteService(String topic)

return the remote service proxy object. Calling @remote annotated methods on this will send to all receivers listening to the service in the cluster.

Parameters:

topic -

Returns:

joinCluster

void joinCluster(String configPath,
               String nodeId,
               String clusterName)
                 throws IOException

joins the cluster defined by the given config. Note that listening/sending must be explicitely enabled after joining. clustername is a Development convenience feature. One can start several clusters with different name without having to reconfigure ports/adresses etc. . However since those clusters share the same network queues/ports, this will slow down communication. DON'T USE FOR PRODUCTION SYSTEMS. In a production system one would run more than one clsuter at a time by using different ports and multicast adresses, so packet filtering is done by the network hardware/kernel.

Parameters:

configPath -

nodeId - - name of the process (will make up the adress of a node e.g. as reported in senderId). MUST NOT EXCEED 8 chars.

clusterName - - see above. If null, take clustername from config. MUST NOT EXCEED 8 chars.

Throws:

IOException

joinCluster

void joinCluster(FCClusterConfig config,
               String nodeId,
               String clusterName)
                 throws IOException

Throws:

IOException

start

void start(String serviceName)

startSending

<T extends FCTopicService> T startSending(String topic,
                                        Class<T> fcBinaryTopicServiceClass)
                                      throws Exception

starts sending on the given topic use this for ConfigBuilder based configs. Directly returns topic

Type Parameters:

T -

Parameters:

topic -

fcBinaryTopicServiceClass -

Returns:

Throws:

Exception

stopReceiving

void stopReceiving(String topicName)

startReceiving

void startReceiving(String topicName,
                  FCBinaryMessageListener listener)

starts listening on the given topic

Parameters:

topicName -

startReceiving

void startReceiving(String topicName,
                  FCTopicService listener)

getStats

TopicStats getStats(String name)

getTopicConfiguration

FCTopicConf getTopicConfiguration(String name)

getActiveTopics

List<String> getActiveTopics()

getRemotingListener

FCRemotingListener getRemotingListener()

setRemotingListener

void setRemotingListener(FCRemotingListener listener)

getMemberShipRemoteProxy

FCMembership getMemberShipRemoteProxy()

returns remote FCMemberShip instance, null if none installed

Returns:

getMemberShipLocal

FCMembership getMemberShipLocal()

Returns:

the local membership instance if any