2 * Private SNMP definitions for CUPS.
4 * Copyright 2007-2014 by Apple Inc.
5 * Copyright 2006-2007 by Easy Software Products, all rights reserved.
7 * These coded instructions, statements, and computer programs are the
8 * property of Apple Inc. and are protected by Federal copyright
9 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
10 * "LICENSE" which should have been included with this file. If this
11 * file is missing or damaged, see the license at "http://www.cups.org/".
14 #ifndef _CUPS_SNMP_PRIVATE_H_
15 # define _CUPS_SNMP_PRIVATE_H_
19 * Include necessary headers.
22 #include <cups/http.h>
29 #define CUPS_SNMP_PORT 161 /* SNMP well-known port */
30 #define CUPS_SNMP_MAX_COMMUNITY 512 /* Maximum size of community name */
31 #define CUPS_SNMP_MAX_OID 128 /* Maximum number of OID numbers */
32 #define CUPS_SNMP_MAX_PACKET 1472 /* Maximum size of SNMP packet */
33 #define CUPS_SNMP_MAX_STRING 1024 /* Maximum size of string */
34 #define CUPS_SNMP_VERSION_1 0 /* SNMPv1 */
41 enum cups_asn1_e
/**** ASN1 request/object types ****/
43 CUPS_ASN1_END_OF_CONTENTS
= 0x00, /* End-of-contents */
44 CUPS_ASN1_BOOLEAN
= 0x01, /* BOOLEAN */
45 CUPS_ASN1_INTEGER
= 0x02, /* INTEGER or ENUMERATION */
46 CUPS_ASN1_BIT_STRING
= 0x03, /* BIT STRING */
47 CUPS_ASN1_OCTET_STRING
= 0x04, /* OCTET STRING */
48 CUPS_ASN1_NULL_VALUE
= 0x05, /* NULL VALUE */
49 CUPS_ASN1_OID
= 0x06, /* OBJECT IDENTIFIER */
50 CUPS_ASN1_SEQUENCE
= 0x30, /* SEQUENCE */
51 CUPS_ASN1_HEX_STRING
= 0x40, /* Binary string aka Hex-STRING */
52 CUPS_ASN1_COUNTER
= 0x41, /* 32-bit unsigned aka Counter32 */
53 CUPS_ASN1_GAUGE
= 0x42, /* 32-bit unsigned aka Gauge32 */
54 CUPS_ASN1_TIMETICKS
= 0x43, /* 32-bit unsigned aka Timeticks32 */
55 CUPS_ASN1_GET_REQUEST
= 0xa0, /* GetRequest-PDU */
56 CUPS_ASN1_GET_NEXT_REQUEST
= 0xa1, /* GetNextRequest-PDU */
57 CUPS_ASN1_GET_RESPONSE
= 0xa2 /* GetResponse-PDU */
59 typedef enum cups_asn1_e cups_asn1_t
; /**** ASN1 request/object types ****/
61 typedef struct cups_snmp_string_s
/**** String value ****/
63 unsigned char bytes
[CUPS_SNMP_MAX_STRING
];
65 unsigned num_bytes
; /* Number of bytes */
68 union cups_snmp_value_u
/**** Object value ****/
70 int boolean
; /* Boolean value */
71 int integer
; /* Integer value */
72 int counter
; /* Counter value */
73 unsigned gauge
; /* Gauge value */
74 unsigned timeticks
; /* Timeticks value */
75 int oid
[CUPS_SNMP_MAX_OID
]; /* OID value */
76 cups_snmp_string_t string
; /* String value */
79 typedef struct cups_snmp_s
/**** SNMP data packet ****/
81 const char *error
; /* Encode/decode error */
82 http_addr_t address
; /* Source address */
83 int version
; /* Version number */
84 char community
[CUPS_SNMP_MAX_COMMUNITY
];
86 cups_asn1_t request_type
; /* Request type */
87 unsigned request_id
; /* request-id value */
88 int error_status
; /* error-status value */
89 int error_index
; /* error-index value */
90 int object_name
[CUPS_SNMP_MAX_OID
];
91 /* object-name value */
92 cups_asn1_t object_type
; /* object-value type */
93 union cups_snmp_value_u
94 object_value
; /* object-value value */
97 typedef void (*cups_snmp_cb_t
)(cups_snmp_t
*packet
, void *data
);
105 # endif /* __cplusplus */
107 extern void _cupsSNMPClose(int fd
) _CUPS_API_1_4
;
108 extern int *_cupsSNMPCopyOID(int *dst
, const int *src
, int dstsize
)
110 extern const char *_cupsSNMPDefaultCommunity(void) _CUPS_API_1_4
;
111 extern int _cupsSNMPIsOID(cups_snmp_t
*packet
, const int *oid
)
113 extern int _cupsSNMPIsOIDPrefixed(cups_snmp_t
*packet
,
114 const int *prefix
) _CUPS_API_1_4
;
115 extern char *_cupsSNMPOIDToString(const int *src
, char *dst
,
116 size_t dstsize
) _CUPS_API_1_4
;
117 extern int _cupsSNMPOpen(int family
) _CUPS_API_1_4
;
118 extern cups_snmp_t
*_cupsSNMPRead(int fd
, cups_snmp_t
*packet
,
119 double timeout
) _CUPS_API_1_4
;
120 extern void _cupsSNMPSetDebug(int level
) _CUPS_API_1_4
;
121 extern int *_cupsSNMPStringToOID(const char *src
,
122 int *dst
, int dstsize
)
124 extern int _cupsSNMPWalk(int fd
, http_addr_t
*address
, int version
,
125 const char *community
, const int *prefix
,
126 double timeout
, cups_snmp_cb_t cb
,
127 void *data
) _CUPS_API_1_4
;
128 extern int _cupsSNMPWrite(int fd
, http_addr_t
*address
, int version
,
129 const char *community
,
130 cups_asn1_t request_type
,
131 const unsigned request_id
,
132 const int *oid
) _CUPS_API_1_4
;
136 # endif /* __cplusplus */
137 #endif /* !_CUPS_SNMP_PRIVATE_H_ */