MadelineProto/src/danog/MadelineProto/MTProtoSession/MsgIdHandlerAbstract.php

67 lines
1.9 KiB
PHP

<?php
/**
* MsgIdHandler module.
*
* This file is part of MadelineProto.
* MadelineProto 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.
* MadelineProto 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 General Public License along with MadelineProto.
* If not, see <http://www.gnu.org/licenses/>.
*
* @author Daniil Gentili <daniil@daniil.it>
* @copyright 2016-2019 Daniil Gentili <daniil@daniil.it>
* @license https://opensource.org/licenses/AGPL-3.0 AGPLv3
*
* @link https://docs.madelineproto.xyz MadelineProto documentation
*/
namespace danog\MadelineProto\MTProtoSession;
/**
* Manages message ids.
*/
abstract class MsgIdHandlerAbstract
{
/**
* Session instance.
*
* @var Session
*/
protected $session;
/**
* Constructor.
*
* @param Session $session Session
*/
public function __construct(Session $session)
{
$this->session = $session;
}
/**
* Check validity of given message ID.
*
* @param string $newMessageId New message ID
* @param array $aargs Params
*
* @return void
*/
abstract public function checkMessageId(string $newMessageId, array $aargs): void;
/**
* Generate outgoing message ID.
*
* @return string
*/
abstract public function generateMessageId(): string;
/**
* Get maximum message ID.
*
* @param boolean $incoming Incoming or outgoing message ID
*
* @return mixed
*/
abstract public function getMaxId(bool $incoming);
}