DiscoveryClient.java

/**
 * Copyright (C) 2012 Ness Computing, Inc.
 *
 * Licensed 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 com.nesscomputing.service.discovery.client;



/**
 * Provides the client side API for service discovery.
 */
public interface DiscoveryClient extends ReadOnlyDiscoveryClient
{
    /**
     * Announces an existing service information. This will be enqueued to the service discovery servers and will be
     * available for service discovery after all servers have picked it up.
     */
    void announce(ServiceInformation serviceInformation);

    /**
     * Unannounce a service information. This uses equals() to determine whether a given service information is present
     * in the client; best is to use the same object that was used for announcing also for unannounce. It is possible that
     * additional service requests are sent in between the unannounce call and all servers and clients having picked up the
     * state.
     */
    void unannounce(ServiceInformation serviceInformation);

    /**
     * Unconditionally unannounce all service information elements registered with this client.
     */
    void unannounceAll();
}