net.openhft.chronicle.engine.api.pubsub

Interface Reference<E>

All Superinterfaces:

Publisher<E>, java.util.function.Supplier<E>, Visitable<E>

All Known Implementing Classes:

RemoteReference, VanillaReference

public interface Reference<E>
extends Publisher<E>, java.util.function.Supplier<E>, Visitable<E>

Hold a reference to a specific topic/key.

Method Summary

Modifier and Type	Method and Description
E	get()
default E	getAndRemove() Remove the topic/key and return the old value
default E	getAndSet(E e) Set a new value and return the old value.
default Class	getType()
default void	publish(E e) Publish to this topic/key.
void	remove() Remove the topic/key
void	set(E e) Set the new value

Methods inherited from interface net.openhft.chronicle.engine.api.pubsub.Publisher

registerSubscriber, subscriberCount, unregisterSubscriber

Methods inherited from interface net.openhft.chronicle.engine.api.Visitable

applyTo, applyTo, asyncUpdate, asyncUpdate, syncUpdate, syncUpdate

Method Detail

get

E get()

Specified by:

get in interface java.util.function.Supplier<E>

Specified by:

get in interface Visitable<E>

Returns:

the current value.

getAndSet

default E getAndSet(E e)

Set a new value and return the old value.

Parameters:

e - to set

Returns:

the old value.

set

void set(E e)

Set the new value

Specified by:

set in interface Visitable<E>

Parameters:

e - replace value

remove

void remove()

Remove the topic/key

getAndRemove

default E getAndRemove()

Remove the topic/key and return the old value

Returns:

the old value.

publish

default void publish(E e)

Publish to this topic/key.

Specified by:

publish in interface Publisher<E>

Parameters:

e - value to publish/set

getType

default Class getType()