Class GetSuccess

Inheritance
object
GetSuccess
Implements
Inherited Members
Namespace: Akka.DistributedData
Assembly: Akka.DistributedData.dll
Syntax
[Serializable]
public sealed class GetSuccess : IGetResponse, INoSerializationVerificationNeeded, IEquatable<GetSuccess>, IReplicatorMessage

Constructors

| Edit this page View Source

GetSuccess(IKey, object, IReplicatedData)

Reply from Get<T>(IKey<T>). The data value is retrieved with Data.

Declaration
public GetSuccess(IKey key, object request, IReplicatedData data)
Parameters
Type Name Description
IKey key
object request
IReplicatedData data

Properties

| Edit this page View Source

Data

Declaration
public IReplicatedData Data { get; }
Property Value
Type Description
IReplicatedData
| Edit this page View Source

IsFailure

True if a failure happened during request fulfillment. False if returned successfully or value not found for the key.

Declaration
public bool IsFailure { get; }
Property Value
Type Description
bool
| Edit this page View Source

IsFound

False if value for request was not found. True otherwise.

Declaration
public bool IsFound { get; }
Property Value
Type Description
bool
| Edit this page View Source

IsSuccessful

True if value for request was successfully returned. False if value was either not found or ended with failure.

Declaration
public bool IsSuccessful { get; }
Property Value
Type Description
bool
| Edit this page View Source

Key

Initial key send by Get<T>(IKey<T>) request.

Declaration
public IKey Key { get; }
Property Value
Type Description
IKey
| Edit this page View Source

Request

Optional object used for request/response correlation.

Declaration
public object Request { get; }
Property Value
Type Description
object

Methods

| Edit this page View Source

Equals(GetSuccess)

Indicates whether the current object is equal to another object of the same type.

Declaration
public bool Equals(GetSuccess other)
Parameters
Type Name Description
GetSuccess other

An object to compare with this object.
Returns
Type Description
bool

true if the current object is equal to the other parameter; otherwise, false.
| Edit this page View Source

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
object obj

The object to compare with the current object.
Returns
Type Description
bool

true if the specified object is equal to the current object; otherwise, false.
Overrides
| Edit this page View Source

GetHashCode()

Serves as the default hash function.

Declaration
public override int GetHashCode()
Returns
Type Description
int

A hash code for the current object.
Overrides
| Edit this page View Source

Get<T>(IKey<T>)

Tries to return a result of the request, given a replicated collection key used when sending a Akka.DistributedData.Replicator request.

Declaration
public T Get<T>(IKey<T> key) where T : IReplicatedData
Parameters
Type Name Description
IKey<T> key

Key send originally with a Akka.DistributedData.Replicator request.
Returns
Type Description
T
Type Parameters
Name Description
T

Replicated data.
Exceptions
Type Condition
KeyNotFoundException

Thrown when no value for provided key was found.
TimeoutException

Thrown when response with given consistency didn't arrive within specified timeout.
| Edit this page View Source

ToString()

Returns a string that represents the current object.

Declaration
public override string ToString()
Returns
Type Description
string

A string that represents the current object.
Overrides

Implements

Extension Methods