hazelcast-master/hazelcast/src/main/java/com/hazelcast/internal/services/NotifiableEventListener.java
/*
 * Copyright (c) 2008-2023, Hazelcast, Inc. All Rights Reserved.
 *
 * 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.hazelcast.internal.services;

import com.hazelcast.spi.impl.eventservice.EventRegistration;
import com.hazelcast.spi.impl.eventservice.EventService;

/**
 * Contract point for event listeners to be notified by {@link EventService}.
 *
 * @param <S> the type of the {@link ManagedService}
 */
public interface NotifiableEventListener<S> {

    /**
     * Called when this listener registered to {@link EventService}.
     *
     * @param service       the service instance that event belongs to
     * @param serviceName   name of the service that event belongs to
     * @param topic         name of the topic that event belongs to
     * @param registration  the {@link EventRegistration} instance
     *                      that holds information about the registration
     */
    void onRegister(S service, String serviceName, String topic, EventRegistration registration);

    /**
     * Called when this listener deregistered from {@link EventService}.
     *
     * @param service       the service instance that event belongs to
     * @param serviceName   name of the service that event belongs to
     * @param topic         name of the topic that event belongs to
     * @param registration  the {@link EventRegistration} instance
     *                      that holds information about the registration
     */
    void onDeregister(S service, String serviceName, String topic, EventRegistration registration);

}
