This is an automated email from the ASF dual-hosted git repository.
xyuanlu pushed a commit to branch metaclient
in repository https://gitbox.apache.org/repos/asf/helix.git
The following commit(s) were added to refs/heads/metaclient by this push:
new 070d83e82 MetaClient Distributed Semaphore API and Permit object
(#2520)
070d83e82 is described below
commit 070d83e82f909b15faa9a98dcf5939da50fb5a79
Author: Marcos Rico Peng <[email protected]>
AuthorDate: Sun Jun 11 00:53:46 2023 -0400
MetaClient Distributed Semaphore API and Permit object (#2520)
MetaClient Distributed Semaphore API and Permit object
---------
Co-authored-by: mapeng <[email protected]>
---
.../recipes/lock/DistributedSemaphore.java | 148 +++++++++++++++++++++
.../helix/metaclient/recipes/lock/Permit.java | 87 ++++++++++++
2 files changed, 235 insertions(+)
diff --git
a/meta-client/src/main/java/org/apache/helix/metaclient/recipes/lock/DistributedSemaphore.java
b/meta-client/src/main/java/org/apache/helix/metaclient/recipes/lock/DistributedSemaphore.java
new file mode 100644
index 000000000..0cccb130f
--- /dev/null
+++
b/meta-client/src/main/java/org/apache/helix/metaclient/recipes/lock/DistributedSemaphore.java
@@ -0,0 +1,148 @@
+package org.apache.helix.metaclient.recipes.lock;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import org.apache.commons.lang3.NotImplementedException;
+import org.apache.helix.metaclient.api.MetaClientInterface;
+import org.apache.helix.metaclient.datamodel.DataRecord;
+import org.apache.helix.metaclient.factories.MetaClientConfig;
+import java.util.Collection;
+import java.util.concurrent.TimeUnit;
+
+public class DistributedSemaphore {
+
+ /**
+ * Create a distributed semaphore client with the given configuration.
+ * @param config configuration of the client
+ */
+ public DistributedSemaphore(MetaClientConfig config) {
+ throw new NotImplementedException("Not implemented yet.");
+ }
+
+ /**
+ * Connect to an existing distributed semaphore client.
+ * @param client client to connect to
+ */
+ public DistributedSemaphore(MetaClientInterface<DataRecord> client) {
+ throw new NotImplementedException("Not implemented yet.");
+ }
+
+ /**
+ * Create a distributed semaphore with the given path and capacity.
+ * @param path path of the semaphore
+ * @param capacity capacity of the semaphore
+ */
+ public void createSemaphore(String path, int capacity) {
+ throw new NotImplementedException("Not implemented yet.");
+ }
+
+ /**
+ * Connect to an existing distributed semaphore.
+ * @param path path of the semaphore
+ */
+ public void connectSemaphore(String path) {
+ throw new NotImplementedException("Not implemented yet.");
+ }
+
+ /**
+ * Acquire a permit. If no permit is available, log error and return null.
+ * @return a permit
+ */
+ public Permit acquire() {
+ throw new NotImplementedException("Not implemented yet.");
+ }
+
+
+ /**
+ * Try to acquire multiple permits. If not enough permits are available, log
error and return null.
+ * @param count number of permits to acquire
+ * @return a collection of permits
+ */
+ public Collection<Permit> acquire(int count) {
+ throw new NotImplementedException("Not implemented yet.");
+ }
+
+ /**
+ * Try to acquire a permit. If no enough permit is available, wait for a
specific time or return when it was able to acquire.
+ * If timeout <=0, then return immediately when not able to acquire.
+ * @param count number of permits to acquire
+ * @param timeout time to wait
+ * @param unit time unit
+ * @return a collection of permits
+ */
+ public Collection<Permit> acquire(int count, long timeout, TimeUnit unit) {
+ throw new NotImplementedException("Not implemented yet.");
+ }
+
+ /**
+ * Get the remaining capacity of the semaphore
+ * @return remaining capacity
+ */
+ public long getRemainingCapacity() {
+ throw new NotImplementedException("Not implemented yet.");
+ }
+
+ /**
+ * Get the semaphore data record
+ * @return semaphore data record
+ */
+ private DataRecord getSemaphore() {
+ throw new NotImplementedException("Not implemented yet.");
+ }
+
+ /**
+ * Return a permit. If the permit is already returned, log and return void.
+ */
+ public void returnPermit(Permit permit) {
+ throw new NotImplementedException("Not implemented yet.");
+ }
+
+ /**
+ * Return a collection of permits. If a permit in that collection is already
returned,
+ * log and return void.
+ */
+ public void returnAllPermits(Collection<Permit> permits) {
+ throw new NotImplementedException("Not implemented yet.");
+ }
+
+ /**
+ * Retrieve a permit from the semaphore data record.
+ * @param path path of the permit
+ * @return a permit
+ */
+ private Permit retrievePermit(String path) {
+ throw new NotImplementedException("Not implemented yet.");
+ }
+
+ /**
+ * Update the remaining capacity of the semaphore after acquiring a permit.
+ * @param count number of permits to acquire
+ */
+ private void updateAcquirePermit(int count) {
+ throw new NotImplementedException("Not implemented yet.");
+ }
+
+ /**
+ * Update the remaining capacity of the semaphore after returning a permit.
+ */
+ private void updateReturnPermit() {
+ throw new NotImplementedException("Not implemented yet.");
+ }
+}
diff --git
a/meta-client/src/main/java/org/apache/helix/metaclient/recipes/lock/Permit.java
b/meta-client/src/main/java/org/apache/helix/metaclient/recipes/lock/Permit.java
new file mode 100644
index 000000000..5af31b59a
--- /dev/null
+++
b/meta-client/src/main/java/org/apache/helix/metaclient/recipes/lock/Permit.java
@@ -0,0 +1,87 @@
+package org.apache.helix.metaclient.recipes.lock;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import org.apache.helix.metaclient.api.MetaClientInterface;
+import org.apache.helix.metaclient.datamodel.DataRecord;
+
+import java.util.concurrent.locks.Lock;
+
+@JsonSerialize(include = JsonSerialize.Inclusion.NON_NULL)
+public class Permit extends DataRecord {
+
+ private static final String DEFAULT_PERMIT_INFO = "permitInfo";
+ public static final long DEFAULT_TIME_PERMIT_ACQUIRED = -1L;
+ public static final long DEFAULT_TIME_SEMAPHORE_CREATED = -1L;
+ private boolean _isReleased;
+
+ public enum PermitAttribute {
+ TIME_PERMIT_ACQUIRED,
+ TIME_SEMAPHORE_CREATED
+ }
+ public Permit() {
+ super(DEFAULT_PERMIT_INFO);
+ setPermitFields(DEFAULT_TIME_PERMIT_ACQUIRED,
DEFAULT_TIME_SEMAPHORE_CREATED);
+ }
+ public Permit(DataRecord record) {
+ this();
+ if (record != null) {
+ long timePermitAcquired =
record.getLongField(PermitAttribute.TIME_PERMIT_ACQUIRED.name(),
DEFAULT_TIME_PERMIT_ACQUIRED);
+ long timeSemaphoreCreated =
record.getLongField(PermitAttribute.TIME_SEMAPHORE_CREATED.name(),
DEFAULT_TIME_SEMAPHORE_CREATED);
+ setPermitFields(timePermitAcquired, timeSemaphoreCreated);
+ }
+ }
+
+ public Permit(DataRecord record, MetaClientInterface.Stat stat) {
+ this(record);
+ setTimeSemaphoreCreated(stat.getCreationTime());
+ setTimePermitAcquired(stat.getModifiedTime());
+ }
+
+ public void setPermitFields(long timePermitAcquired, long
timeSemaphoreCreated) {
+ setTimePermitAcquired(timePermitAcquired);
+ setTimeSemaphoreCreated(timeSemaphoreCreated);
+ _isReleased = false;
+ }
+
+ public void setTimePermitAcquired(long timePermitAcquired) {
+ setLongField(PermitAttribute.TIME_PERMIT_ACQUIRED.name(),
timePermitAcquired);
+ }
+
+ public void setTimeSemaphoreCreated(long timeSemaphoreCreated) {
+ setLongField(PermitAttribute.TIME_SEMAPHORE_CREATED.name(),
timeSemaphoreCreated);
+ }
+
+ public void getTimePermitAcquired() {
+ getLongField(PermitAttribute.TIME_PERMIT_ACQUIRED.name(),
DEFAULT_TIME_PERMIT_ACQUIRED);
+ }
+
+ public void getTimeSemaphoreCreated() {
+ getLongField(PermitAttribute.TIME_SEMAPHORE_CREATED.name(),
DEFAULT_TIME_SEMAPHORE_CREATED);
+ }
+
+ public boolean isReleased() {
+ return _isReleased;
+ }
+ public void releasePermit() {
+ _isReleased = true;
+ }
+}
