-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathPayloadReader.php
More file actions
74 lines (65 loc) · 1.88 KB
/
Copy pathPayloadReader.php
File metadata and controls
74 lines (65 loc) · 1.88 KB
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
<?php
/**
* Copyright © EcomDev B.V. All rights reserved.
* See LICENSE for license details.
*/
declare(strict_types=1);
namespace EcomDev\MySQLBinaryProtocol;
/**
* Reader for buffer fragments
*
*/
interface PayloadReader
{
/**
* Reads fixed value integer
*
* @see https://dev.mysql.com/doc/dev/mysql-server/latest/page_protocol_basic_dt_integers.html
* @return int|float
*
* @throws IncompleteBufferException
*/
public function readFixedInteger(int $bytes);
/**
* Reads length encoded integer
*
* @see https://dev.mysql.com/doc/dev/mysql-server/latest/page_protocol_basic_dt_integers.html
* @return int|float
*
* @throws IncompleteBufferException
*/
public function readLengthEncodedIntegerOrNull();
/**
* Reads string of specified length from buffer
*
* @see https://dev.mysql.com/doc/dev/mysql-server/latest/page_protocol_basic_dt_strings.html
*
*
* @throws IncompleteBufferException
*/
public function readFixedString(int $length): string;
/**
* Reads string that is has length as the first part of the fragment
*
* @see https://dev.mysql.com/doc/dev/mysql-server/latest/page_protocol_basic_dt_strings.html
*
* @throws IncompleteBufferException
*/
public function readLengthEncodedStringOrNull(): ?string;
/**
* Reads string till x00 character
*
* @see https://dev.mysql.com/doc/dev/mysql-server/latest/page_protocol_basic_dt_strings.html
*
* @throws IncompleteBufferException
*/
public function readNullTerminatedString(): string;
/**
* Reads string that is rest of payload
*
* @see https://dev.mysql.com/doc/dev/mysql-server/latest/page_protocol_basic_dt_strings.html
*
* @throws IncompleteBufferException
*/
public function readRestOfPacketString(): string;
}