net.openhft.chronicle.engine.pubsub

Class RemoteReference<E>

java.lang.Object

net.openhft.chronicle.network.connection.AbstractStatelessClient<ReferenceHandler.EventId>

net.openhft.chronicle.engine.pubsub.RemoteReference<E>

All Implemented Interfaces:

Closeable, AutoCloseable, java.util.function.Supplier<E>, Publisher<E>, Reference<E>, Visitable<E>

public class RemoteReference<E>
extends AbstractStatelessClient<ReferenceHandler.EventId>
implements Reference<E>

Created by Rob Austin

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<Object,Long>	subscribersToTid

Fields inherited from class net.openhft.chronicle.network.connection.AbstractStatelessClient

csp, hub

Constructor Summary

Constructors

Constructor and Description
RemoteReference(RequestContext requestContext, Asset asset)
RemoteReference(TcpChannelHub hub, Class<E> messageClass, String fullName)

Method Summary

Modifier and Type	Method and Description
<T,R> R	applyTo(net.openhft.chronicle.core.util.SerializableBiFunction<E,T,R> function, T argument) Apply a function which takes an argument.
<R> R	applyTo(net.openhft.chronicle.core.util.SerializableFunction<E,R> function) Apply a function to the visitable and return the result.
<T> void	asyncUpdate(net.openhft.chronicle.core.util.SerializableBiFunction<E,T,E> updateFunction, T argument) Apply a function to visitable potentially asynchronously.
void	asyncUpdate(net.openhft.chronicle.core.util.SerializableFunction<E,E> updateFunction) Apply a function to visitable potentially asynchronously.
E	get()
E	getAndRemove() Remove the topic/key and return the old value
E	getAndSet(E e) Set a new value and return the old value.
void	registerSubscriber(boolean bootstrap, Subscriber subscriber) Add a subscription to this spepcific topic
void	remove() Remove the topic/key
void	set(E event) Set the new value
int	subscriberCount()
<UT,RT,R> R	syncUpdate(net.openhft.chronicle.core.util.SerializableBiFunction<E,UT,E> updateFunction, UT updateArgument, net.openhft.chronicle.core.util.SerializableBiFunction<E,RT,R> returnFunction, RT returnArgument) Apply a function to update the state of a visible, and apply a function to return a result object synchronously.
<R> R	syncUpdate(net.openhft.chronicle.core.util.SerializableFunction<E,E> updateFunction, net.openhft.chronicle.core.util.SerializableFunction<E,R> returnFunction) Apply a function to update the state of a visible, and apply a function to return a result object synchronously.
void	unregisterSubscriber(Subscriber<E> subscriber) Remove a subscriber

Methods inherited from class net.openhft.chronicle.network.connection.AbstractStatelessClient

checkIsData, close, proxyReturnBoolean, proxyReturnBooleanWithArgs, proxyReturnBooleanWithSequence, proxyReturnByte, proxyReturnByte, proxyReturnInt, proxyReturnLong, proxyReturnTypedObject, proxyReturnUint16, proxyReturnVoid, proxyReturnVoid, proxyReturnWireConsumer, proxyReturnWireConsumerInOut, readBoolean, readInt, readReply, readReplyConsumer, sendEvent, sendEventAsync, sendEventAsyncWithoutLock, toParameters, writeAsyncMetaData, writeMetaDataForKnownTID, writeMetaDataStartTime

Methods inherited from class java.lang.Object

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

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

getType, publish

Field Detail

subscribersToTid

protected final Map<Object,Long> subscribersToTid

Constructor Detail

RemoteReference

public RemoteReference(RequestContext requestContext,
                       Asset asset)

RemoteReference

public RemoteReference(TcpChannelHub hub,
                       Class<E> messageClass,
                       String fullName)
                throws AssetNotFoundException

Throws:

AssetNotFoundException

Method Detail

set

public void set(E event)

Description copied from interface: Reference

Set the new value

Specified by:

set in interface Reference<E>

Specified by:

set in interface Visitable<E>

Parameters:

event - replace value

get

public E get()

Specified by:

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

Specified by:

get in interface Reference<E>

Specified by:

get in interface Visitable<E>

Returns:

the current value.

getAndSet

public E getAndSet(E e)

Description copied from interface: Reference

Set a new value and return the old value.

Specified by:

getAndSet in interface Reference<E>

Parameters:

e - to set

Returns:

the old value.

remove

public void remove()

Description copied from interface: Reference

Remove the topic/key

Specified by:

remove in interface Reference<E>

getAndRemove

public E getAndRemove()

Description copied from interface: Reference

Remove the topic/key and return the old value

Specified by:

getAndRemove in interface Reference<E>

Returns:

the old value.

unregisterSubscriber

public void unregisterSubscriber(Subscriber<E> subscriber)

Description copied from interface: Publisher

Remove a subscriber

Specified by:

unregisterSubscriber in interface Publisher<E>

Parameters:

subscriber - to remove

subscriberCount

public int subscriberCount()

Specified by:

subscriberCount in interface Publisher<E>

Returns:

the number of subscriptions.

registerSubscriber

public void registerSubscriber(boolean bootstrap,
                               @NotNull
                               Subscriber subscriber)
                        throws AssetNotFoundException

Description copied from interface: Publisher

Add a subscription to this spepcific topic

Specified by:

registerSubscriber in interface Publisher<E>

Parameters:

bootstrap - to bootstrap

subscriber - to register

Throws:

AssetNotFoundException - if the topic no longer exists.

applyTo

public <R> R applyTo(@NotNull
                     net.openhft.chronicle.core.util.SerializableFunction<E,R> function)

Description copied from interface: Visitable

Apply a function to the visitable and return the result. This function is assumed to not change the value in any significant way.

Specified by:

applyTo in interface Visitable<E>

Type Parameters:

R - data type to return.

Parameters:

function - to apply e.g. call a getter

Returns:

the result of the code called.

asyncUpdate

public void asyncUpdate(@NotNull
                        net.openhft.chronicle.core.util.SerializableFunction<E,E> updateFunction)

Description copied from interface: Visitable

Apply a function to visitable potentially asynchronously. This function is assumed to replace the value and trigger and events or replciated changes.

Specified by:

asyncUpdate in interface Visitable<E>

Parameters:

updateFunction - to update the state of the visitiable.

syncUpdate

public <R> R syncUpdate(@NotNull
                        net.openhft.chronicle.core.util.SerializableFunction<E,E> updateFunction,
                        @NotNull
                        net.openhft.chronicle.core.util.SerializableFunction<E,R> returnFunction)

Description copied from interface: Visitable

Apply a function to update the state of a visible, and apply a function to return a result object synchronously.

Specified by:

syncUpdate in interface Visitable<E>

Type Parameters:

R - data type to return.

Parameters:

updateFunction - update to apply to the value.

returnFunction - derive an object to return

Returns:

the result of the code called.

applyTo

public <T,R> R applyTo(@NotNull
                       net.openhft.chronicle.core.util.SerializableBiFunction<E,T,R> function,
                       T argument)

Description copied from interface: Visitable

Apply a function which takes an argument. This argument may contain a combination of data. This function is assumed to not change the value in any significant way.

Specified by:

applyTo in interface Visitable<E>

Type Parameters:

T - type of the argument

R - type of the return value.

Parameters:

function - to apply

argument - for the functions use.

Returns:

data derived.

asyncUpdate

public <T> void asyncUpdate(@NotNull
                            net.openhft.chronicle.core.util.SerializableBiFunction<E,T,E> updateFunction,
                            T argument)

Description copied from interface: Visitable

Apply a function to visitable potentially asynchronously. This argument may contain a combination of data. This function is assumed to replace the value and trigger and events or replciated changes.

Specified by:

asyncUpdate in interface Visitable<E>

Type Parameters:

T - type of the argument

Parameters:

updateFunction - to update the state of the visitiable.

argument - for the functions use.

syncUpdate

public <UT,RT,R> R syncUpdate(@NotNull
                              net.openhft.chronicle.core.util.SerializableBiFunction<E,UT,E> updateFunction,
                              @Nullable
                              UT updateArgument,
                              @NotNull
                              net.openhft.chronicle.core.util.SerializableBiFunction<E,RT,R> returnFunction,
                              @Nullable
                              RT returnArgument)

Description copied from interface: Visitable

Apply a function to update the state of a visible, and apply a function to return a result object synchronously. This argument may contain a combination of data. Optionally the arguments could be null.

Specified by:

syncUpdate in interface Visitable<E>

R - data type to return.

Parameters:

updateFunction - update to apply to the value.

updateArgument - for the update function to use.

returnFunction - derive an object to return

returnArgument - for the return value function to use

Returns:

the result of the code called.