SAP ABAP Class CL_RSPO_SNMP (SNMP API for spool WPs)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-CCM-PRN (Application Component) Print and Output Management
     ⤷ SPOO (Package) Spool

Properties

Class	CL_RSPO_SNMP
Short Description	SNMP API for spool WPs
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SPOO	Spool
Created	20080226	SAP
Last change	20080612	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_RSPO_SNMP has no forward declaration.

Interfaces

Class CL_RSPO_SNMP has no interface implemented.

Friends

Class CL_RSPO_SNMP has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	SNMP_ERR_INTERNAL_ERROR	Constant	Private	☐	Type reference (TYPE)	INT4	5	SNMP error: Internal error	20080226
2	SNMP_ERR_INVALID_OID	Constant	Private	☐	Type reference (TYPE)	INT4	2	SNMP error: Invalid object identifier	20080226
3	SNMP_ERR_PACKET_ERROR	Constant	Private	☐	Type reference (TYPE)	INT4	3	SNMP error: Packet error	20080226
4	SNMP_ERR_TIME_OUT	Constant	Private	☐	Type reference (TYPE)	INT4	4	SNMP error: Time out	20080226
5	SNMP_ERR_UNKNOWN_HOST	Constant	Private	☐	Type reference (TYPE)	INT4	1	SNMP error: Unknown host	20080226

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	GET	Static method	Public	Method	SNMP GET request: Public method	20080226
2	GET_PRINTER_STATUS	Static method	Public	Method	Get device status and error state from printer	20080226
3	PRV_GET	Static method	Private	Method	SNMP GET request: Private kernel module	20080226
4	PRV_WALK	Static method	Private	Method	SNMP WALK function:Private kernel module	20080226
5	WALK	Static method	Public	Method	SNMP WALK request: Public method	20080226

Events

Class CL_RSPO_SNMP has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	T_SNMP_RESPONSE	Private	See coding			20080226	T_SNMP_RESPONSE(2048) type c
2	T_SNMP_RESPONSE_TAB	Private	See coding			20080226	T_SNMP_RESPONSE_TAB type STANDARD TABLE OF T_SNMP_RESPONSE
3	T_SNMP_WALK_ENTRY	Public	See coding			20080226	begin of T_SNMP_WALK_ENTRY , OID type string, datatype type string, RESPONSE type string, END OF T_SNMP_WALK_ENTRY
4	T_SNMP_WALK_TAB	Public	See coding			20080226	T_SNMP_WALK_TAB type STANDARD TABLE OF T_SNMP_WALK_ENTRY

Method Signatures

Method GET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COMMUNITY	Call by reference	☑	Type reference (TYPE)	STRING	'public'	Community string	20080226
2	Importing	OID	Call by reference	☐	Type reference (TYPE)	STRING		OID string	20080226
3	Importing	PRINTER	Call by reference	☐	Type reference (TYPE)	STRING		IP adress of network printer	20080226
4	Exporting	RESPONSE	Call by reference	☐	Type reference (TYPE)	STRING		SNMP response string	20080226
5	Importing	VERSION	Call by reference	☑	Type reference (TYPE)	STRING	'1'	SNMP version	20080226

#	Exception	Resumable	Description	Created on
1	CX_SNMP_INTERNAL_ERROR	☐	SNMP internal error	20080226
2	CX_SNMP_INVALID_OID	☐	Requested OID could not be resolved .	20080226
3	CX_SNMP_PACKET_ERROR	☐	An SNMP packet error occured.	20080226
4	CX_SNMP_TIME_OUT	☐	A SNMP 'Time Out' error occured.	20080226
5	CX_SNMP_UNKNOWN_HOST	☐	Domain name or dotted IP address of SNMP host unknown	20080226

Method GET_PRINTER_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COMMUNITY	Call by reference	☑	Type reference (TYPE)	STRING	'public'	Community string	20080226
2	Exporting	DEV_STATUS	Call by reference	☐	Type reference (TYPE)	STRING		Device status of a network printer	20080226
3	Exporting	ERR_STATE	Call by reference	☐	Type reference (TYPE)	STRING		Detected error state of a network printer	20080226
4	Importing	PRINTER	Call by reference	☐	Type reference (TYPE)	STRING		IP adress of network printer	20080226
5	Exporting	PRT_STATUS	Call by reference	☐	Type reference (TYPE)	STRING		Printer status of a network printer	20080226
6	Importing	VERSION	Call by reference	☑	Type reference (TYPE)	STRING	'1'	SNMP version	20080226

#	Exception	Resumable	Description	Created on
1	CX_SNMP_INTERNAL_ERROR	☐	SNMP internal error	20080226
2	CX_SNMP_INVALID_OID	☐	Requested OID could not be resolved .	20080226
3	CX_SNMP_PACKET_ERROR	☐	An SNMP packet error occured.	20080226
4	CX_SNMP_TIME_OUT	☐	A SNMP 'Time Out' error occured.	20080226
5	CX_SNMP_UNKNOWN_HOST	☐	Domain name or dotted IP address of SNMP host unknown	20080226

Method PRV_GET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COMMUNITY	Call by reference	☐	Type reference (TYPE)	STRING		SNMP community	20080226
2	Importing	PRINTER	Call by reference	☐	Type reference (TYPE)	STRING		Printer network address	20080226
3	Exporting	RC	Call by reference	☐	Type reference (TYPE)	INT4		Return code	20080226
4	Importing	REQUEST_OID	Call by reference	☐	Type reference (TYPE)	STRING		OID identifier of request	20080226
5	Exporting	RESPONSE	Call by reference	☐	Type reference (TYPE)	STRING		SNMP server response	20080226
6	Importing	VERSION	Call by reference	☐	Type reference (TYPE)	STRING		SNMP version	20080226

Method PRV_GET on class CL_RSPO_SNMP has no exception.

Method PRV_WALK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COMMUNITY	Call by reference	☐	Type reference (TYPE)	STRING		SNMP community	20080226
2	Importing	PRINTER	Call by reference	☐	Type reference (TYPE)	STRING		Printer network address	20080226
3	Exporting	RC	Call by reference	☐	Type reference (TYPE)	INT4		Return code	20080226
4	Importing	REQUEST_OID	Call by reference	☐	Type reference (TYPE)	STRING		OID identifier of request	20080226
5	Exporting	RESPONSE	Call by reference	☐	Type reference (TYPE)	T_SNMP_RESPONSE_TAB		SNMP server response	20080226
6	Importing	VERSION	Call by reference	☐	Type reference (TYPE)	STRING		SNMP version	20080226

Method PRV_WALK on class CL_RSPO_SNMP has no exception.

Method WALK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COMMUNITY	Call by reference	☐	Type reference (TYPE)	STRING		SNMP community	20080226
2	Importing	OID	Call by reference	☐	Type reference (TYPE)	STRING		OID identifier of request	20080226
3	Importing	PRINTER	Call by reference	☐	Type reference (TYPE)	STRING		Printer network address	20080226
4	Exporting	RESPONSE	Call by reference	☐	Type reference (TYPE)	T_SNMP_WALK_TAB		SNMP server response	20080226
5	Importing	VERSION	Call by reference	☐	Type reference (TYPE)	STRING		SNMP version	20080226

#	Exception	Resumable	Description	Created on
1	CX_SNMP_INTERNAL_ERROR	☐	SNMP internal error	20080226
2	CX_SNMP_INVALID_OID	☐	Requested OID could not be resolved .	20080226
3	CX_SNMP_PACKET_ERROR	☐	An SNMP packet error occured.	20080226
4	CX_SNMP_TIME_OUT	☐	A SNMP 'Time Out' error occured.	20080226
5	CX_SNMP_UNKNOWN_HOST	☐	Domain name or dotted IP address of SNMP host unknown	20080226

History

Last changed by/on	SAP	20080612
SAP Release Created in