Package org.apache.pekko.actor.typed.internal.receptionist

Class ReceptionistMessages.Listing<T>

java.lang.Object

org.apache.pekko.actor.typed.internal.receptionist.ReceptionistMessages.Listing<T>

All Implemented Interfaces:

Serializable, Receptionist.Listing, scala.Equals, scala.Product

Enclosing class:

ReceptionistMessages

public static final class ReceptionistMessages.Listing<T>
extends Object
implements Receptionist.Listing, scala.Product, Serializable

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
scala.collection.immutable.Set<ActorRef<T>>	_allServiceInstances()
scala.collection.immutable.Set<ActorRef<T>>	_serviceInstances()
<M> scala.collection.immutable.Set<ActorRef<M>>	allServiceInstances(ServiceKey<M> key)	Scala API: Return both the reachable and the unreachable service instances.
boolean	canEqual(Object x$1)
<T> ReceptionistMessages.Listing<T>	copy(ServiceKey<T> key, scala.collection.immutable.Set<ActorRef<T>> _serviceInstances, scala.collection.immutable.Set<ActorRef<T>> _allServiceInstances, boolean servicesWereAddedOrRemoved)
<T> ServiceKey<T>	copy$default$1()
<T> scala.collection.immutable.Set<ActorRef<T>>	copy$default$2()
<T> scala.collection.immutable.Set<ActorRef<T>>	copy$default$3()
<T> boolean	copy$default$4()
boolean	equals(Object x$1)
<M> Set<ActorRef<M>>	getAllServiceInstances(ServiceKey<M> key)	Java API: Return both the reachable and the unreachable service instances.
<M> Set<ActorRef<M>>	getServiceInstances(ServiceKey<M> key)	Java API: Return the reachable service instances.
int	hashCode()
boolean	isForKey(ServiceKey<?> key)
ServiceKey<T>	key()	Scala API
int	productArity()
Object	productElement(int x$1)
String	productElementName(int x$1)
scala.collection.Iterator<Object>	productIterator()
String	productPrefix()
<M> scala.collection.immutable.Set<ActorRef<M>>	serviceInstances(ServiceKey<M> key)	Scala API: Return the reachable service instances.
boolean	servicesWereAddedOrRemoved()	Returns true only if this Listing was sent triggered by new actors added or removed to the receptionist.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface scala.Product

productElementNames

Methods inherited from interface org.apache.pekko.actor.typed.receptionist.Receptionist.Listing

getKey

Method Details

key

public ServiceKey<T> key()

Description copied from interface: Receptionist.Listing

Scala API

Specified by:

key in interface Receptionist.Listing

_serviceInstances

public scala.collection.immutable.Set<ActorRef<T>> _serviceInstances()

_allServiceInstances

public scala.collection.immutable.Set<ActorRef<T>> _allServiceInstances()

servicesWereAddedOrRemoved

public boolean servicesWereAddedOrRemoved()

Description copied from interface: Receptionist.Listing

Returns true only if this Listing was sent triggered by new actors added or removed to the receptionist. When false the event is only about reachability changes - meaning that the full set of actors (Receptionist.Listing.allServiceInstances(org.apache.pekko.actor.typed.receptionist.ServiceKey<T>) or Receptionist.Listing.getAllServiceInstances(org.apache.pekko.actor.typed.receptionist.ServiceKey<T>)) is the same as the previous Listing.

knowing this is useful for subscribers only concerned with Receptionist.Listing.allServiceInstances(org.apache.pekko.actor.typed.receptionist.ServiceKey<T>) or Receptionist.Listing.getAllServiceInstances(org.apache.pekko.actor.typed.receptionist.ServiceKey<T>) that can then ignore Listings related to reachability.

In a non-clustered ActorSystem this will be true for all listings. For Find queries and the initial listing for a Subscribe this will always be true.

Specified by:

servicesWereAddedOrRemoved in interface Receptionist.Listing

isForKey

public boolean isForKey(ServiceKey<?> key)

Specified by:

isForKey in interface Receptionist.Listing

serviceInstances

public <M>
scala.collection.immutable.Set<ActorRef<M>> serviceInstances(ServiceKey<M> key)

Description copied from interface: Receptionist.Listing

Scala API: Return the reachable service instances.

In a non-clustered ActorSystem this will always be all registered instances for a service key.

For a clustered ActorSystem it only contain services on nodes that are not seen as unreachable (note that they could have still have become unreachable between this message being sent and the receiving actor processing it).

For a list including both reachable and unreachable instances see Receptionist.Listing.allServiceInstances(org.apache.pekko.actor.typed.receptionist.ServiceKey<T>)

Also, see ServiceKey.Listing for more convenient pattern matching

Specified by:

serviceInstances in interface Receptionist.Listing

getServiceInstances

public <M> Set<ActorRef<M>> getServiceInstances(ServiceKey<M> key)

Description copied from interface: Receptionist.Listing

Java API: Return the reachable service instances.

In a non-clustered ActorSystem this will always be all registered instances for a service key.

For a clustered ActorSystem it only contain services on nodes that has are not seen as unreachable (note that they could have still have become unreachable between this message being sent and the receiving actor processing it).

For a list including both reachable and unreachable instances see Receptionist.Listing.getAllServiceInstances(org.apache.pekko.actor.typed.receptionist.ServiceKey<T>)

Specified by:

getServiceInstances in interface Receptionist.Listing

allServiceInstances

public <M>
scala.collection.immutable.Set<ActorRef<M>> allServiceInstances(ServiceKey<M> key)

Description copied from interface: Receptionist.Listing

Scala API: Return both the reachable and the unreachable service instances.

In a non-clustered ActorSystem this will always be the same as Receptionist.Listing.serviceInstances(org.apache.pekko.actor.typed.receptionist.ServiceKey<T>).

For a clustered ActorSystem this include both services on nodes that are reachable and nodes that are unreachable.

Specified by:

allServiceInstances in interface Receptionist.Listing

getAllServiceInstances

public <M> Set<ActorRef<M>> getAllServiceInstances(ServiceKey<M> key)

Description copied from interface: Receptionist.Listing

Java API: Return both the reachable and the unreachable service instances.

In a non-clustered ActorSystem this will always be the same as Receptionist.Listing.getServiceInstances(org.apache.pekko.actor.typed.receptionist.ServiceKey<T>).

For a clustered ActorSystem this include both services on nodes that are reachable and nodes that are unreachable.

Specified by:

getAllServiceInstances in interface Receptionist.Listing

copy

public <T> ReceptionistMessages.Listing<T> copy(ServiceKey<T> key,
 scala.collection.immutable.Set<ActorRef<T>> _serviceInstances,
 scala.collection.immutable.Set<ActorRef<T>> _allServiceInstances,
 boolean servicesWereAddedOrRemoved)

copy$default$1

public <T> ServiceKey<T> copy$default$1()

copy$default$2

public <T>
scala.collection.immutable.Set<ActorRef<T>> copy$default$2()

copy$default$3

public <T>
scala.collection.immutable.Set<ActorRef<T>> copy$default$3()

copy$default$4

public <T> boolean copy$default$4()

productPrefix

public String productPrefix()

Specified by:

productPrefix in interface scala.Product

productArity

public int productArity()

Specified by:

productArity in interface scala.Product

productElement

public Object productElement(int x$1)

Specified by:

productElement in interface scala.Product

productIterator

public scala.collection.Iterator<Object> productIterator()

Specified by:

productIterator in interface scala.Product

canEqual

public boolean canEqual(Object x$1)

Specified by:

canEqual in interface scala.Equals

productElementName

public String productElementName(int x$1)

Specified by:

productElementName in interface scala.Product

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object x$1)

Specified by:

equals in interface scala.Equals

Overrides:

equals in class Object