net.openhft.chronicle.salt

Class EasyBox.Nonce

java.lang.Object

net.openhft.chronicle.salt.EasyBox.Nonce

Enclosing class:

EasyBox

public static class EasyBox.Nonce
extends Object

Helper class to wrap Nonce creation and re-use A nonce should only be used for a single message exchange, then refreshed Refresh either by calling next() or stir() depending on the use case - next increments the nonce by 1 in a deterministic fashion (eg for ordered message exchange) - stir fully randomises the nonce again Explicitly named static methods are provided to help avoid mistakes from calling the wrong constructor overload

Field Summary

Fields

Modifier and Type	Field and Description
net.openhft.chronicle.bytes.BytesStore	store

Method Summary

Modifier and Type	Method and Description
long	address() Get the address of this nonce (only needed if using the explicit low-level interface)
static EasyBox.Nonce	deterministic(net.openhft.chronicle.bytes.BytesStore seed) Generate deterministic nonce from BytesStore accessing full 32 seed bytes Optionally pass in the underlying BytesStore, else one is created
static EasyBox.Nonce	deterministic(net.openhft.chronicle.bytes.BytesStore store, net.openhft.chronicle.bytes.BytesStore seed)
static EasyBox.Nonce	deterministic(net.openhft.chronicle.bytes.BytesStore store, long id)
static EasyBox.Nonce	deterministic(long id) /** Generate deterministic nonce from simple long id (which only uses 8 out of 32 seed bytes) Optionally pass in the underlying BytesStore, else one is created
static EasyBox.Nonce	generate() Generate random nonce.
static EasyBox.Nonce	generate(net.openhft.chronicle.bytes.BytesStore store)
void	next() Refresh this nonce for reuse for another message with the same key pair by incrementing value by 1
void	stir() Refresh this nonce for reuse for another message with the same key pair by randomising

Methods inherited from class java.lang.Object

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

Field Detail

store

public final net.openhft.chronicle.bytes.BytesStore store

Method Detail

generate

public static EasyBox.Nonce generate()

Generate random nonce. Optionally pass in the underlying BytesStore, else one is created

Returns:

- a random nonce

generate

public static EasyBox.Nonce generate(net.openhft.chronicle.bytes.BytesStore store)

deterministic

public static EasyBox.Nonce deterministic(long id)

/** Generate deterministic nonce from simple long id (which only uses 8 out of 32 seed bytes) Optionally pass in the underlying BytesStore, else one is created

Parameters:

id - - the seed value (2^64 options_

Returns:

- a deterministic nonce

deterministic

public static EasyBox.Nonce deterministic(net.openhft.chronicle.bytes.BytesStore store,
                                          long id)

deterministic

public static EasyBox.Nonce deterministic(net.openhft.chronicle.bytes.BytesStore seed)

Generate deterministic nonce from BytesStore accessing full 32 seed bytes Optionally pass in the underlying BytesStore, else one is created

Parameters:

seed - - seed bytes, which should be at least 32 bytes long

Returns:

- a deterministic nonce

deterministic

public static EasyBox.Nonce deterministic(net.openhft.chronicle.bytes.BytesStore store,
                                          net.openhft.chronicle.bytes.BytesStore seed)

next

public void next()

Refresh this nonce for reuse for another message with the same key pair by incrementing value by 1

stir

public void stir()

Refresh this nonce for reuse for another message with the same key pair by randomising

address

public long address()

Get the address of this nonce (only needed if using the explicit low-level interface)

Returns:

- the start address of the underlying memory