File: Frame.php

package info (click to toggle)
php-amqplib 3.7.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,060 kB
  • sloc: php: 13,145; makefile: 77; sh: 27
file content (78 lines) | stat: -rw-r--r-- 1,566 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
<?php

namespace PhpAmqpLib\Channel;
use PhpAmqpLib\Wire\AMQPReader;

/**
 * @link https://livebook.manning.com/book/rabbitmq-in-depth/chapter-2/v-13/22
 * @link https://www.rabbitmq.com/resources/specs/amqp0-9-1.pdf 4.2.6 Content Framing
 */
final class Frame
{
    public const FRAME_HEADER_SIZE = AMQPReader::OCTET + AMQPReader::SHORT + AMQPReader::LONG;
    public const END = 0xCE;

    public const TYPE_METHOD = 1;
    public const TYPE_HEADER = 2;
    public const TYPE_BODY = 3;
    public const TYPE_HEARTBEAT = 8;

    /** @var int */
    private $type;

    /** @var int */
    private $channel;

    /** @var int */
    private $size;

    /** @var string|null */
    private $payload;

    public function __construct(int $type, int $channel, int $size, ?string $payload = null)
    {
        $this->type = $type;
        $this->channel = $channel;
        $this->size = $size;
        $this->payload = $payload;
    }

    /**
     * @return int
     */
    public function getType(): int
    {
        return $this->type;
    }

    /**
     * @return int
     */
    public function getChannel(): int
    {
        return $this->channel;
    }

    /**
     * @return int
     */
    public function getSize(): int
    {
        return $this->size;
    }

    public function getPayload(): ?string
    {
        return $this->payload;
    }

    public function isMethod(): bool
    {
        return $this->type === self::TYPE_METHOD;
    }

    public function isHeartbeat(): bool
    {
        return $this->type === self::TYPE_HEARTBEAT;
    }
}