/*
 * Copyright (C) 2026  Tim Zimmermann <tim@aglais.org>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.aglais.zms.client;

import org.aglais.zms.api.core.APIConstants;

/**
 * Connection change reason values
 */
public enum ConnectionChangeReason {
    /**
     * Connect request by calling {@link AglaisZMSClient#connect}
     */
    CONNECT_REQUEST,
    /**
     * Disconnect request by calling {@link AglaisZMSClient#disconnect}
     */
    DISCONNECT_REQUEST,
    /**
     * Disconnected because of an authentication failure
     */
    AUTHENTICATION_FAILURE,
    /**
     * Disconnected because of a network failure
     */
    NETWORK_FAILURE,
    /**
     * Disconnected because the magic string returned by {@link APIConstants#URL_API_HEALTH_CHECK} did not match
     * {@link APIConstants#API_HEALTH_CHECK_MAGIC}
     */
    INVALID_MAGIC,
}