edu.iu.dsc.tws.api.comms

Interface DestinationSelector

All Known Implementing Classes:

ByteSelector, DefaultDestinationSelector, HashingSelector, LoadBalanceSelector, SimpleKeyBasedSelector

public interface DestinationSelector

Destination selector interface needs to be implemented when creating destination selection logic. For example for a keyed operation a destination selector will be used to calculate the correct destination based on the key values.

Method Summary

Modifier and Type	Method and Description
default void	commit(int source, int obtained) Say that we have used the obtained destination
int	next(int source, java.lang.Object data) Get next destination using source and the data
default int	next(int source, java.lang.Object key, java.lang.Object data) Get next destination using source, key and data
default void	prepare(Communicator comm, java.util.Set<java.lang.Integer> sources, java.util.Set<java.lang.Integer> destinations) Prepare the destination selector
default void	prepare(Communicator comm, java.util.Set<java.lang.Integer> sources, java.util.Set<java.lang.Integer> destinations, MessageType keyType, MessageType dataType) Prepare the destination selector, if this method is not overridden to support keyType and dataType those values will be simply discarded.

Method Detail

prepare

default void prepare(Communicator comm,
                     java.util.Set<java.lang.Integer> sources,
                     java.util.Set<java.lang.Integer> destinations)

Prepare the destination selector

Parameters:

comm - the communicator

sources - sources

destinations - destination

prepare

default void prepare(Communicator comm,
                     java.util.Set<java.lang.Integer> sources,
                     java.util.Set<java.lang.Integer> destinations,
                     MessageType keyType,
                     MessageType dataType)

Prepare the destination selector, if this method is not overridden to support keyType and dataType those values will be simply discarded.

Parameters:

comm - the communicator

sources - sources

destinations - destination

keyType - type of key that this selector handles

dataType - type of data that this selector handles

next

int next(int source,
         java.lang.Object data)

Get next destination using source and the data

Parameters:

source - source

data - data

Returns:

the next destination

next

default int next(int source,
                 java.lang.Object key,
                 java.lang.Object data)

Get next destination using source, key and data

Parameters:

source - source

key - key

data - data

Returns:

the next destination

commit

default void commit(int source,
                    int obtained)

Say that we have used the obtained destination

Parameters:

source - source

obtained - obtained destination