org.thales.punch.libraries.netty.groups

Class Groups<T>

java.lang.Object

org.thales.punch.libraries.netty.groups.Groups<T>

Type Parameters:

T - the type of read objects

public class Groups<T>
extends Object

A group encapsulates several destinations.

At the end you want to read/write from/to any of them.

Author:

dimi

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.logging.log4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
Groups()

Method Summary

Modifier and Type	Method and Description
Groups<T>	add(org.thales.punch.settings.api.ISettingsMap destination, NettyTcpClient<T> client) Add a destination to our groups.
boolean	isActive()
Groups<T>	setStartupTimeout(long t) Set a startup timeout
Groups<T>	setWaitConnectionsTimeout(long t) Set a wait connection timeout
Groups<T>	start() Start the group
Groups<T>	start(long startupTimeout, long connectionTimeout) Start the groups of destination.
void	stop() Stop all the groups
void	update() This method is called whenver a destination to any of the group joins or leaves.
boolean	write(T packet, Object context) Write a packet of data to one of the group destination.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static org.apache.logging.log4j.Logger logger

Constructor Detail

Groups

public Groups()

Method Detail

add

public Groups<T> add(org.thales.punch.settings.api.ISettingsMap destination,
                     NettyTcpClient<T> client)

Add a destination to our groups. This adds a group if needed, and increase the configured weight of that group.

You MUST add all your destinations before starting the group.

Parameters:

destination - a new destination

client - the associated netty client

Returns:

this instance

start

public Groups<T> start(long startupTimeout,
                       long connectionTimeout)

Start the groups of destination.

Parameters:

startupTimeout - give some time for the initial connections to be setup. Use this to target the primary group in the likely case all groups including the primary are up.

connectionTimeout - should no connections be available at all in no groups, you can make the start wait for that amount of time.

Returns:

this group

stop

public void stop()

Stop all the groups

start

public Groups<T> start()

Start the group

Returns:

this instance

setStartupTimeout

public Groups<T> setStartupTimeout(long t)

Set a startup timeout

Parameters:

t - the startup timeout in milliseconds

Returns:

this group

setWaitConnectionsTimeout

public Groups<T> setWaitConnectionsTimeout(long t)

Set a wait connection timeout

Parameters:

t - the startup timeout in milliseconds

Returns:

this group

update

public void update()

This method is called whenver a destination to any of the group joins or leaves. The total weight of one of the group necesserally changed. We simply reorder all group and reassign the current group to the one with the heaviiest weight.

write

public boolean write(T packet,
                     Object context)

Write a packet of data to one of the group destination.

Pay attention to the return code. If false, the group failed to send it to any destination. In that case there will be no upcall to an acker in charge of acknowledging or failing your data upfront. You have to take care of it by yourself.

Parameters:

packet - the data to send

context - an object you need back at acknowledgement time

Returns:

false if the data could no be sent to any destination.

isActive

public boolean isActive()

Returns:

true if the group has some connected destination.