PacketReliability.php

<?php
 
/*
 * This file is part of RakLib.
 * Copyright (C) 2014-2022 PocketMine Team <https://github.com/pmmp/RakLib>
 *
 * RakLib is not affiliated with Jenkins Software LLC nor RakNet.
 *
 * RakLib is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 */
 
declare(strict_types=1);
 
namespace raklib\protocol;
 
abstract class PacketReliability{
 
    /*
     * From https://github.com/OculusVR/RakNet/blob/master/Source/PacketPriority.h
     *
     * Default: 0b010 (2) or 0b011 (3)
     */
 
    public const UNRELIABLE = 0;
    public const UNRELIABLE_SEQUENCED = 1;
    public const RELIABLE = 2;
    public const RELIABLE_ORDERED = 3;
    public const RELIABLE_SEQUENCED = 4;
 
    /* The following reliabilities are used in RakNet internals, but never sent on the wire. */
    public const UNRELIABLE_WITH_ACK_RECEIPT = 5;
    public const RELIABLE_WITH_ACK_RECEIPT = 6;
    public const RELIABLE_ORDERED_WITH_ACK_RECEIPT = 7;
 
    public const MAX_ORDER_CHANNELS = 32;
 
    public static function isReliable(int $reliability) : bool{
        return (
            $reliability === self::RELIABLE or
            $reliability === self::RELIABLE_ORDERED or
            $reliability === self::RELIABLE_SEQUENCED or
            $reliability === self::RELIABLE_WITH_ACK_RECEIPT or
            $reliability === self::RELIABLE_ORDERED_WITH_ACK_RECEIPT
        );
    }
 
    public static function isSequenced(int $reliability) : bool{
        return (
            $reliability === self::UNRELIABLE_SEQUENCED or
            $reliability === self::RELIABLE_SEQUENCED
        );
    }
 
    public static function isOrdered(int $reliability) : bool{
        return (
            $reliability === self::RELIABLE_ORDERED or
            $reliability === self::RELIABLE_ORDERED_WITH_ACK_RECEIPT
        );
    }
 
    public static function isSequencedOrOrdered(int $reliability) : bool{
        return (
            $reliability === self::UNRELIABLE_SEQUENCED or
            $reliability === self::RELIABLE_ORDERED or
            $reliability === self::RELIABLE_SEQUENCED or
            $reliability === self::RELIABLE_ORDERED_WITH_ACK_RECEIPT
        );
    }
}