Skip to content
Orleans logoMicrosoft Orleans

ZooKeeperBasedMembershipTable

class

Namespace: Orleans.Runtime.Membership

A Membership Table implementation using Apache Zookeeper 3.4.6 https://zookeeper.apache.org/doc/r3.4.6/ 
public class ZooKeeperBasedMembershipTable : IMembershipTable

Remarks

A brief overview of ZK features used: The data is represented by a tree of nodes (similar to a file system). Every node is addressed by a path and can hold data as a byte array and has a version. When a node is created, its version is 0. Upon updates, the version is atomically incremented. An update can also be conditional on an expected current version. A transaction can hold several operations, which succeed or fail atomically. when creating a zookeeper client, one can set a base path where all operations are relative to. In this implementation: Every Orleans deployment has a node /UniqueDeploymentId Every Silo's state is saved in /UniqueDeploymentId/IP:Port@Gen Every Silo's IAmAlive is saved in /UniqueDeploymentId/IP:Port@Gen/IAmAlive IAmAlive is saved in a separate node so owner heartbeat writes preserve the membership row's version. Membership updates atomically modify the row and deployment nodes, preserving the separate heartbeat node. a node's ZK version is its ETag: the table version is the version of /UniqueDeploymentId the silo entry version is the version of /UniqueDeploymentId/IP:Port@Gen

Constructors

Methods

  • CleanupDefunctSiloEntries(DateTimeOffset) Removes dead silo entries whose last known update precedes beforeDate.
  • CleanupDefunctSiloEntriesAsync(DateTimeOffset, CancellationToken) Removes dead silo entries whose last known update precedes beforeDate.
  • DeleteMembershipTableEntries(string) Deletes all table entries of the given clusterId
  • DeleteMembershipTableEntriesAsync(string, CancellationToken) Deletes all table entries of the given clusterId
  • InitializeMembershipTable(bool) Initializes the ZooKeeper based membership table.
  • InitializeMembershipTableAsync(bool, CancellationToken) Initializes the membership table, will be called before all other methods
  • InsertRow(MembershipEntry, TableVersion) Atomically tries to insert (add) a new MembershipEntry for one silo and also update the TableVersion. If operation succeeds, the following changes would be made to the table: 1) New MembershipEntry will be added to the table. 2) The newly added MembershipEntry will also be added with the new unique automatically generated eTag. 3) TableVersion.Version in the table will be updated to the new TableVersion.Version. 4) TableVersion etag in the table will be updated to the new unique automatically generated eTag. All those changes to the table, insert of a new row and update of the table version and the associated etags, should happen atomically, or fail atomically with no side effects. The operation should fail in each of the following conditions: 1) A MembershipEntry for a given silo already exist in the table 2) Update of the TableVersion failed since the given TableVersion etag (as specified by the TableVersion.VersionEtag property) did not match the TableVersion etag in the table.
  • InsertRowAsync(MembershipEntry, TableVersion, CancellationToken) Atomically tries to insert (add) a new MembershipEntry for one silo and also update the TableVersion. If operation succeeds, the following changes would be made to the table: 1) New MembershipEntry will be added to the table. 2) The newly added MembershipEntry will have a provider-defined row eTag. 3) TableVersion.Version in the table will be updated to the new TableVersion.Version. 4) TableVersion etag in the table will be updated to the new unique automatically generated eTag. All those changes to the table, insert of a new row and update of the table version and the associated etags, should happen atomically, or fail atomically with no side effects. The operation should fail in each of the following conditions: 1) A MembershipEntry for a given silo already exist in the table 2) Update of the TableVersion failed since the given TableVersion etag (as specified by the TableVersion.VersionEtag property) did not match the TableVersion etag in the table.
  • ReadAll Atomically reads the full content of the Membership Table. The returned MembershipTableData includes all MembershipEntry entry for all silos in the table and the TableVersion for this table. The MembershipEntries and the TableVersion have to be read atomically.
  • ReadAllAsync(CancellationToken) Atomically reads the full content of the Membership Table. The returned MembershipTableData includes all MembershipEntry entry for all silos in the table and the TableVersion for this table. The MembershipEntries and the TableVersion have to be read atomically.
  • ReadRow(SiloAddress) Atomically reads the Membership Table information about a given silo. The returned MembershipTableData includes one MembershipEntry entry for a given silo and the TableVersion for this table. The MembershipEntry and the TableVersion have to be read atomically.
  • ReadRowAsync(SiloAddress, CancellationToken) Atomically reads the Membership Table information about a given silo. The returned MembershipTableData includes one MembershipEntry entry for a given silo and the TableVersion for this table. The MembershipEntry and the TableVersion have to be read atomically.
  • UpdateIAmAlive(MembershipEntry) Writes the owning silo's IAmAlive timestamp to its heartbeat node using one unconditional native update. The membership row and table version are preserved. Native storage failures propagate to the caller.
  • UpdateIAmAliveAsync(MembershipEntry, CancellationToken) Updates the IAmAliveTime column of the MembershipEntry for this silo.
  • UpdateRow(MembershipEntry, string, TableVersion) Atomically tries to update the MembershipEntry for one silo and also update the TableVersion. If operation succeeds, the following changes would be made to the table: 1) The MembershipEntry for this silo will be updated to the new MembershipEntry (the old entry will be fully substituted by the new entry) 2) The eTag for the updated MembershipEntry will also be eTag with the new unique automatically generated eTag. 3) TableVersion.Version in the table will be updated to the new TableVersion.Version. 4) TableVersion etag in the table will be updated to the new unique automatically generated eTag. All those changes to the table, update of a new row and update of the table version and the associated etags, should happen atomically, or fail atomically with no side effects. The operation should fail in each of the following conditions: 1) A MembershipEntry for a given silo does not exist in the table 2) A MembershipEntry for a given silo exist in the table but its etag in the table does not match the provided etag. 3) Update of the TableVersion failed since the given TableVersion etag (as specified by the TableVersion.VersionEtag property) did not match the TableVersion etag in the table.
  • UpdateRowAsync(MembershipEntry, string, TableVersion, CancellationToken) Atomically tries to update the MembershipEntry for one silo and also update the TableVersion. If operation succeeds, the following changes would be made to the table: 1) The MembershipEntry for this silo will be updated using the supplied entry. 2) The row eTag for the updated MembershipEntry will reflect the provider's metadata or concurrency-token policy. 3) TableVersion.Version in the table will be updated to the new TableVersion.Version. 4) TableVersion etag in the table will be updated to the new unique automatically generated eTag. All those changes to the table, update of a new row and update of the table version and the associated etags, should happen atomically, or fail atomically with no side effects. The operation should fail in each of the following conditions: 1) A MembershipEntry for a given silo does not exist in the table 2) Update of the TableVersion failed since the given TableVersion etag (as specified by the TableVersion.VersionEtag property) did not match the TableVersion etag in the table. 3) The provider validates a separate canonical row concurrency token and the supplied etag does not match it.