# Copyright 2021 Google LLC
#
# 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.

from abc import ABCMeta, abstractmethod


class SubscriberResetHandler(metaclass=ABCMeta):
    """Helps to reset subscriber state when the `RESET` signal is received from the server."""

    @abstractmethod
    async def handle_reset(self):
        """Reset subscriber state.

        Raises:
            GoogleAPICallError: If reset handling fails. The subscriber will shut down.
        """
        raise NotImplementedError()