Package uk.ac.manchester.spinnaker.alloc

Class SpallocProperties.TxrxProperties

java.lang.Object

uk.ac.manchester.spinnaker.alloc.SpallocProperties.TxrxProperties

Enclosing class:

SpallocProperties

public static class SpallocProperties.TxrxProperties
extends Object

Controls how Spalloc talks to BMPs on machines.

Constructor Summary

Constructors

Constructor	Description
TxrxProperties(Duration period, Duration probeInterval, int powerAttempts, int fpgaAttempts, boolean fpgaReload, int buildAttempts, boolean dummy, Duration offWaitTime)

Method Summary

Modifier and Type	Method	Description
@jakarta.validation.constraints.Positive int	getBuildAttempts()	Number of attempts that will be made to bring up a transceiver, provided the failures are due to timeouts and not outright network errors.
@jakarta.validation.constraints.Positive int	getFpgaAttempts()
@NotNull Duration	getOffWaitTime()
@NotNull Duration	getPeriod()	How long between when we send requests to the BMP control tasks.
@jakarta.validation.constraints.Positive int	getPowerAttempts()
@NotNull Duration	getProbeInterval()
boolean	isDummy()	Useful for testing only.
boolean	isFpgaReload()

Methods inherited from class java.lang.Object

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

Constructor Details

TxrxProperties

@ConstructorBinding
public TxrxProperties(@DefaultValue("10s")
 Duration period,
 @DefaultValue("15s")
 Duration probeInterval,
 @DefaultValue("2")
 int powerAttempts,
 @DefaultValue("3")
 int fpgaAttempts,
 @DefaultValue("false")
 boolean fpgaReload,
 @DefaultValue("5")
 int buildAttempts,
 @DefaultValue("false")
 boolean dummy,
 @DefaultValue("30s")
 Duration offWaitTime)

Parameters:

period - How long between when we send requests to the BMP control tasks.

probeInterval - The basic wait time used by the BMP control tasks.

powerAttempts - Number of attempts that will be made to switch on a board.

fpgaAttempts - Number of attempts that will be made to bring up an FPGA.

fpgaReload - Whether to reload the FPGA bitfiles when they don't come up correctly.

buildAttempts - Number of attempts that will be made to bring up a transceiver, provided the failures are due to timeouts and not outright network errors. Note that a failure to bring up a transceiver is lethal to the service.

dummy - Whether to use a dummy transceiver. Useful for testing only.

offWaitTime - How long to wait between powering off and powering on a board.

Method Details

getPeriod

@NotNull
public @NotNull Duration getPeriod()

How long between when we send requests to the BMP control tasks.

Returns:

How long between when we send requests to the BMP control tasks.

getProbeInterval

@NotNull
public @NotNull Duration getProbeInterval()

Returns:

The basic wait time used by the BMP control tasks.

getOffWaitTime

@NotNull
public @NotNull Duration getOffWaitTime()

getPowerAttempts

@Positive
public @jakarta.validation.constraints.Positive int getPowerAttempts()

Returns:

Number of attempts that will be made to switch on a board.

getFpgaAttempts

@Positive
public @jakarta.validation.constraints.Positive int getFpgaAttempts()

Returns:

Number of attempts that will be made to bring up an FPGA.

isFpgaReload

public boolean isFpgaReload()

Returns:

Whether to reload the FPGA bitfiles when they don't come up correctly.

getBuildAttempts

@Positive
public @jakarta.validation.constraints.Positive int getBuildAttempts()

Number of attempts that will be made to bring up a transceiver, provided the failures are due to timeouts and not outright network errors. Note that a failure to bring up a transceiver is lethal to the service.

Returns:

Number of attempts that will be made to bring up a transceiver.

isDummy

public boolean isDummy()

Useful for testing only.

Returns:

Whether to use a dummy transceiver.