org.opendaylight.controller.cluster.databroker.actors.dds

Interface DataStoreClient

All Superinterfaces:

AutoCloseable, org.opendaylight.yangtools.concepts.Identifiable<org.opendaylight.controller.cluster.access.concepts.ClientIdentifier>

@Beta
public interface DataStoreClient
extends org.opendaylight.yangtools.concepts.Identifiable<org.opendaylight.controller.cluster.access.concepts.ClientIdentifier>, AutoCloseable

Client interface for interacting with the frontend actor. This interface is the primary access point through which the DistributedDataStore frontend interacts with backend Shards.

Keep this interface as clean as possible, as it needs to be implemented in thread-safe and highly-efficient manner.

Author:

Robert Varga

Method Summary

Modifier and Type	Method and Description
void	close()
ClientLocalHistory	createLocalHistory() Create a new local history.
ClientSnapshot	createSnapshot() Create a new free-standing snapshot.
ClientTransaction	createTransaction() Create a new free-standing transaction.
org.opendaylight.controller.cluster.access.concepts.ClientIdentifier	getIdentifier()

Method Detail

getIdentifier

@Nonnull
org.opendaylight.controller.cluster.access.concepts.ClientIdentifier getIdentifier()

Specified by:

getIdentifier in interface org.opendaylight.yangtools.concepts.Identifiable<org.opendaylight.controller.cluster.access.concepts.ClientIdentifier>

close

void close()

Specified by:

close in interface AutoCloseable

createLocalHistory

@Nonnull
ClientLocalHistory createLocalHistory()

Create a new local history. ClientLocalHistory represents the interface exposed to the client.

Returns:

Client history handle

createSnapshot

@Nonnull
ClientSnapshot createSnapshot()

Create a new free-standing snapshot.

Returns:

Client snapshot handle

createTransaction

@Nonnull
ClientTransaction createTransaction()

Create a new free-standing transaction.

Returns:

Client transaction handle