org.apache.dubbo.registry.xds.util.protocol.XdsProtocol Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of dubbo Show documentation

The all in one project of dubbo

There is a newer version: 3.3.0-beta.3

/*
 * 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.
 */
package org.apache.dubbo.registry.xds.util.protocol;

import java.util.Set;
import java.util.function.Consumer;

public interface XdsProtocol {
    /**
     * Gets all {@link T resource} by the specified resource name.
     * For LDS, the {@param resourceNames} is ignored
     *
     * @param resourceNames specified resource name
     * @return resources, null if request failed
     */
    T getResource(Set resourceNames);

    /**
     * Add a observer resource with {@link Consumer}
     *
     * @param resourceNames specified resource name
     * @param consumer      resource notifier, will be called when resource updated
     * @return requestId, used when resourceNames update with {@link XdsProtocol#updateObserve(long, Set)}
     */
    long observeResource(Set resourceNames, Consumer consumer);

    /**
     * Update observed resource list in {@link XdsProtocol#observeResource(Set, Consumer)}
     *
     * @param request       requestId returned by {@link XdsProtocol#observeResource(Set, Consumer)}
     * @param resourceNames new resource name list to observe
     */
    void updateObserve(long request, Set resourceNames);
}