org.elastos.carrier

Class Carrier.Options

java.lang.Object

org.elastos.carrier.Carrier.Options

Enclosing class:

Carrier

public static class Carrier.Options
extends java.lang.Object

Options defines several settings that control the way the Carrier node connects to the carrier network. Default values are not defined for bootstraps options, so application should be set bootstrap nodes clearly.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Carrier.Options.BootstrapNode
static class	Carrier.Options.ExpressNode

Constructor Summary

Constructors

Constructor and Description
Options()

Method Summary

Modifier and Type	Method and Description
java.util.List<Carrier.Options.BootstrapNode>	getBootstrapNodes()
java.util.List<Carrier.Options.ExpressNode>	getExpressNodes()
java.lang.String	getPersistentLocation() Get the persistent data location.
byte[]	getSecretKey() Get the secret key.
boolean	getUdpEnabled() Get the udp transport used or not.
Carrier.Options	setBootstrapNodes(java.util.List<Carrier.Options.BootstrapNode> bootstrapNodes)
Carrier.Options	setExpressNodes(java.util.List<Carrier.Options.ExpressNode> expressNodes)
Carrier.Options	setPersistentLocation(java.lang.String persistentLocation) Set the persistent data location.
Carrier.Options	setSecretKey(byte[] secretKey) Set the secret key.
Carrier.Options	setUdpEnabled(boolean udpEnabled) Set to use udp transport or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

Options

public Options()

Method Detail

setPersistentLocation

public Carrier.Options setPersistentLocation(java.lang.String persistentLocation)

Set the persistent data location. The location must be set.

Parameters:

persistentLocation - The persistent data location to set

Returns:

The current Options object reference.

getPersistentLocation

public java.lang.String getPersistentLocation()

Get the persistent data location.

Returns:

The persistent data location

setSecretKey

public Carrier.Options setSecretKey(byte[] secretKey)

Set the secret key. The key is optional to be set.

Parameters:

secretKey - The secret key to set

Returns:

The current Options object reference.

getSecretKey

public byte[] getSecretKey()

Get the secret key.

Returns:

The secret key

setUdpEnabled

public Carrier.Options setUdpEnabled(boolean udpEnabled)

Set to use udp transport or not. Setting this value to false will force carrier node to TCP only, which will potentially slow down the message to run through.

Parameters:

udpEnabled - flag to enable or disable udp transport.

Returns:

The current options object reference.

getUdpEnabled

public boolean getUdpEnabled()

Get the udp transport used or not.

Returns:

The value of enable/dsiable udp transport.

setBootstrapNodes

public Carrier.Options setBootstrapNodes(java.util.List<Carrier.Options.BootstrapNode> bootstrapNodes)

getBootstrapNodes

public java.util.List<Carrier.Options.BootstrapNode> getBootstrapNodes()

setExpressNodes

public Carrier.Options setExpressNodes(java.util.List<Carrier.Options.ExpressNode> expressNodes)

getExpressNodes

public java.util.List<Carrier.Options.ExpressNode> getExpressNodes()