xref: /PHP-8.1/ext/snmp/snmp.stub.php (revision dd83ced6) 
1<?php
2
3/** @generate-class-entries */
4
5function snmpget(string $hostname, string $community, array|string $object_id, int $timeout = -1, int $retries = -1): mixed {}
6
7function snmpgetnext(string $hostname, string $community, array|string $object_id, int $timeout = -1, int $retries = -1): mixed {}
8
9function snmpwalk(string $hostname, string $community, array|string $object_id, int $timeout = -1, int $retries = -1): array|false {}
10
11function snmprealwalk(string $hostname, string $community, array|string $object_id, int $timeout = -1, int $retries = -1): array|false {}
12
13/** @alias snmprealwalk */
14function snmpwalkoid(string $hostname, string $community, array|string $object_id, int $timeout = -1, int $retries = -1): array|false {}
15
16function snmpset(string $hostname, string $community, array|string $object_id, array|string $type, array|string $value, int $timeout = -1, int $retries = -1): bool {}
17
18function snmp_get_quick_print(): bool {}
19
20function snmp_set_quick_print(bool $enable): bool {}
21
22function snmp_set_enum_print(bool $enable): bool {}
23
24function snmp_set_oid_output_format(int $format): bool {}
25
26/** @alias snmp_set_oid_output_format */
27function snmp_set_oid_numeric_print(int $format): bool {}
28
29function snmp2_get(string $hostname, string $community, array|string $object_id, int $timeout = -1, int $retries = -1): mixed {}
30
31function snmp2_getnext(string $hostname, string $community, array|string $object_id, int $timeout = -1, int $retries = -1): mixed {}
32
33function snmp2_walk(string $hostname, string $community, array|string $object_id, int $timeout = -1, int $retries = -1): array|false {}
34
35function snmp2_real_walk(string $hostname, string $community, array|string $object_id, int $timeout = -1, int $retries = -1): array|false {}
36
37function snmp2_set(string $hostname, string $community, array|string $object_id, array|string $type, array|string $value, int $timeout = -1, int $retries = -1): bool {}
38
39function snmp3_get(
40    string $hostname, string $security_name, string $security_level,
41    string $auth_protocol, string $auth_passphrase,
42    string $privacy_protocol, string $privacy_passphrase,
43    array|string $object_id, int $timeout = -1, int $retries = -1): mixed {}
44
45function snmp3_getnext(
46    string $hostname, string $security_name, string $security_level,
47    string $auth_protocol, string $auth_passphrase,
48    string $privacy_protocol, string $privacy_passphrase,
49    array|string $object_id, int $timeout = -1, int $retries = -1): mixed {}
50
51function snmp3_walk(
52    string $hostname, string $security_name, string $security_level,
53    string $auth_protocol, string $auth_passphrase,
54    string $privacy_protocol, string $privacy_passphrase,
55    array|string $object_id, int $timeout = -1, int $retries = -1): array|false {}
56
57function snmp3_real_walk(
58    string $hostname, string $security_name, string $security_level,
59    string $auth_protocol, string $auth_passphrase,
60    string $privacy_protocol, string $privacy_passphrase,
61    array|string $object_id, int $timeout = -1, int $retries = -1): array|false {}
62
63function snmp3_set(
64    string $hostname, string $security_name, string $security_level,
65    string $auth_protocol, string $auth_passphrase,
66    string $privacy_protocol, string $privacy_passphrase,
67    array|string $object_id, array|string $type, array|string $value,
68    int $timeout = -1, int $retries = -1): bool {}
69
70function snmp_set_valueretrieval(int $method): bool {}
71
72function snmp_get_valueretrieval(): int {}
73
74function snmp_read_mib(string $filename): bool {}
75
76class SNMP
77{
78    /** @readonly */
79    public array $info;
80    public ?int $max_oids;
81    public int $valueretrieval;
82    public bool $quick_print;
83    public bool $enum_print;
84    public int $oid_output_format;
85    public bool $oid_increasing_check;
86    public int $exceptions_enabled;
87
88    public function __construct(int $version, string $hostname, string $community, int $timeout = -1, int $retries = -1) {}
89
90    /** @tentative-return-type */
91    public function close(): bool {}
92
93    /** @tentative-return-type */
94    public function setSecurity(
95        string $securityLevel, string $authProtocol = "", string $authPassphrase = "",
96        string $privacyProtocol = "", string $privacyPassphrase = "",
97        string $contextName = "", string $contextEngineId = ""): bool {}
98
99    /** @tentative-return-type */
100    public function get(array|string $objectId, bool $preserveKeys = false): mixed {}
101
102    /** @tentative-return-type */
103    public function getnext(array|string $objectId): mixed {}
104
105    /** @tentative-return-type */
106    public function walk(array|string $objectId, bool $suffixAsKey = false, int $maxRepetitions = -1, int $nonRepeaters = -1): array|false {}
107
108    /** @tentative-return-type */
109    public function set(array|string $objectId, array|string $type, array|string $value): bool {}
110
111    /** @tentative-return-type */
112    public function getErrno(): int {}
113
114    /** @tentative-return-type */
115    public function getError(): string {}
116}
117
118class SNMPException extends RuntimeException
119{
120}
121