org.sobotics.redunda

Class PingService

java.lang.Object

org.sobotics.redunda.PingService

public class PingService
extends java.lang.Object

Manages the connection to Redunda

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	apiKey The API-key for the current instance.
PingServiceDelegate	delegate The object that will be notified about status-changes.
static java.lang.String	location The location, the bot is running on Note: Accessing this variable will not contact Redunda.
static java.util.concurrent.atomic.AtomicBoolean	standby Stores if the bot should be on standby; true by default

Constructor Summary

Constructors

Constructor and Description
PingService() Initialize with default values
PingService(java.lang.String key) Initializes the object with the api key
PingService(java.lang.String key, java.lang.String botVersion) Initializes the object with the api key and bot-version
PingService(java.lang.String key, java.lang.String botVersion, int pingInterval) Initializes the object with a `pingInterval` in seconds, the bot's verision and the api key

Method Summary

Modifier and Type	Method and Description
DataService	buildDataService() Returns a `DataService` with the same API-key as `PingService`
boolean	checkStandbyStatus() Fetches the current standby status synchronously from the server If an exception occurs, the status will be `true`.
boolean	getDebugging() Returns is PingService is in debugging mode.
void	setDebugging(boolean debug) Enables or disables the debugging mode.
void	start() Resets the executor services and starts pinging the server

Methods inherited from class java.lang.Object

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

Field Detail

apiKey

public java.lang.String apiKey

The API-key for the current instance. You can get the key in the Instances-overview on Redunda

delegate

public PingServiceDelegate delegate

The object that will be notified about status-changes.

standby

public static java.util.concurrent.atomic.AtomicBoolean standby

Stores if the bot should be on standby; true by default

location

public static java.lang.String location

The location, the bot is running on Note: Accessing this variable will not contact Redunda. You should ping Redunda first.

Constructor Detail

PingService

public PingService()

Initialize with default values

PingService

public PingService(java.lang.String key)

Initializes the object with the api key

Parameters:

key - The API key for Redunda. You can get it form the instances overview

PingService

public PingService(java.lang.String key,
                   java.lang.String botVersion)

Initializes the object with the api key and bot-version

Parameters:

key - The API key for Redunda. You can get it form the instances overview

botVersion - The version of your bot as string

PingService

public PingService(java.lang.String key,
                   java.lang.String botVersion,
                   int pingInterval)

Initializes the object with a `pingInterval` in seconds, the bot's verision and the api key

Parameters:

key - The API key for Redunda. You can get it form the instances overview

botVersion - The version of your bot as string

pingInterval - The time in seconds between two pings. (30 by default)

Method Detail

buildDataService

public DataService buildDataService()

Returns a `DataService` with the same API-key as `PingService`

Returns:

A `DataService`

setDebugging

public void setDebugging(boolean debug)

Enables or disables the debugging mode. If the debugging mode is activated, the bot will never be on standby.

Parameters:

debug - The new value

getDebugging

public boolean getDebugging()

Returns is PingService is in debugging mode.

Returns:

true, if debugging is enabled

start

public final void start()

Resets the executor services and starts pinging the server

checkStandbyStatus

public boolean checkStandbyStatus()

Fetches the current standby status synchronously from the server If an exception occurs, the status will be `true`. The value is affected by the debug-mode.

Returns:

The standby-status