4 * SNMP definitions for the Common UNIX Printing System (CUPS).
6 * This API is PRIVATE and subject to change. No third-party applications
7 * should use the SNMP API defined in this file.
9 * Copyright 2007-2008 by Apple Inc.
10 * Copyright 2006-2007 by Easy Software Products, all rights reserved.
12 * These coded instructions, statements, and computer programs are the
13 * property of Apple Inc. and are protected by Federal copyright
14 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
15 * "LICENSE" which should have been included with this file. If this
16 * file is missing or damaged, see the license at "http://www.cups.org/".
18 * This file is subject to the Apple OS-Developed Software exception.
22 # define _CUPS_SNMP_H_
26 * Include necessary headers.
36 #define CUPS_SNMP_PORT 161 /* SNMP well-known port */
37 #define CUPS_SNMP_MAX_OID 128 /* Maximum number of OID numbers */
38 #define CUPS_SNMP_MAX_PACKET 1472 /* Maximum size of SNMP packet */
39 #define CUPS_SNMP_MAX_STRING 512 /* Maximum size of string */
40 #define CUPS_SNMP_VERSION_1 0 /* SNMPv1 */
47 enum cups_asn1_e
/**** ASN1 request/object types ****/
49 CUPS_ASN1_END_OF_CONTENTS
= 0x00, /* End-of-contents */
50 CUPS_ASN1_BOOLEAN
= 0x01, /* BOOLEAN */
51 CUPS_ASN1_INTEGER
= 0x02, /* INTEGER or ENUMERATION */
52 CUPS_ASN1_BIT_STRING
= 0x03, /* BIT STRING */
53 CUPS_ASN1_OCTET_STRING
= 0x04, /* OCTET STRING */
54 CUPS_ASN1_NULL_VALUE
= 0x05, /* NULL VALUE */
55 CUPS_ASN1_OID
= 0x06, /* OBJECT IDENTIFIER */
56 CUPS_ASN1_SEQUENCE
= 0x30, /* SEQUENCE */
57 CUPS_ASN1_HEX_STRING
= 0x40, /* Binary string aka Hex-STRING */
58 CUPS_ASN1_COUNTER
= 0x41, /* 32-bit unsigned aka Counter32 */
59 CUPS_ASN1_GAUGE
= 0x42, /* 32-bit unsigned aka Gauge32 */
60 CUPS_ASN1_TIMETICKS
= 0x43, /* 32-bit unsigned aka Timeticks32 */
61 CUPS_ASN1_GET_REQUEST
= 0xa0, /* GetRequest-PDU */
62 CUPS_ASN1_GET_NEXT_REQUEST
= 0xa1, /* GetNextRequest-PDU */
63 CUPS_ASN1_GET_RESPONSE
= 0xa2 /* GetResponse-PDU */
65 typedef enum cups_asn1_e cups_asn1_t
; /**** ASN1 request/object types ****/
67 struct cups_snmp_hexstring_s
/**** Hex-STRING value ****/
69 unsigned char bytes
[CUPS_SNMP_MAX_STRING
];
71 int num_bytes
; /* Number of bytes */
74 union cups_snmp_value_u
/**** Object value ****/
76 int boolean
; /* Boolean value */
77 int integer
; /* Integer value */
78 unsigned counter
; /* Counter value */
79 unsigned gauge
; /* Gauge value */
80 unsigned timeticks
; /* Timeticks value */
81 int oid
[CUPS_SNMP_MAX_OID
]; /* OID value */
82 char string
[CUPS_SNMP_MAX_STRING
];
84 struct cups_snmp_hexstring_s hex_string
;
85 /* Hex string value */
88 typedef struct cups_snmp_s
/**** SNMP data packet ****/
90 const char *error
; /* Encode/decode error */
91 http_addr_t address
; /* Source address */
92 int version
; /* Version number */
93 char community
[CUPS_SNMP_MAX_STRING
];
95 cups_asn1_t request_type
; /* Request type */
96 int request_id
; /* request-id value */
97 int error_status
; /* error-status value */
98 int error_index
; /* error-index value */
99 int object_name
[CUPS_SNMP_MAX_OID
];
100 /* object-name value */
101 cups_asn1_t object_type
; /* object-value type */
102 union cups_snmp_value_u
103 object_value
; /* object-value value */
106 typedef void (*cups_snmp_cb_t
)(cups_snmp_t
*packet
, void *data
);
114 # endif /* __cplusplus */
116 extern void _cupsSNMPClose(int fd
) _CUPS_API_1_4
;
117 extern int *_cupsSNMPCopyOID(int *dst
, const int *src
, int dstsize
)
119 extern const char *_cupsSNMPDefaultCommunity(void) _CUPS_API_1_4
;
120 extern int _cupsSNMPIsOID(cups_snmp_t
*packet
, const int *oid
)
122 extern int _cupsSNMPIsOIDPrefixed(cups_snmp_t
*packet
,
123 const int *prefix
) _CUPS_API_1_4
;
124 extern char *_cupsSNMPOIDToString(const int *src
, char *dst
,
125 size_t dstsize
) _CUPS_API_1_4
;
126 extern int _cupsSNMPOpen(int family
) _CUPS_API_1_4
;
127 extern cups_snmp_t
*_cupsSNMPRead(int fd
, cups_snmp_t
*packet
,
128 double timeout
) _CUPS_API_1_4
;
129 extern void _cupsSNMPSetDebug(int level
) _CUPS_API_1_4
;
130 extern int *_cupsSNMPStringToOID(const char *src
,
131 int *dst
, int dstsize
)
133 extern int _cupsSNMPWalk(int fd
, http_addr_t
*address
, int version
,
134 const char *community
, const int *prefix
,
135 double timeout
, cups_snmp_cb_t cb
,
136 void *data
) _CUPS_API_1_4
;
137 extern int _cupsSNMPWrite(int fd
, http_addr_t
*address
, int version
,
138 const char *community
,
139 cups_asn1_t request_type
,
140 const unsigned request_id
,
141 const int *oid
) _CUPS_API_1_4
;
145 # endif /* __cplusplus */
146 #endif /* !_CUPS_SNMP_H_ */