1 marek 1.1 // Copyright (c) 2005 DMTF.  All rights reserved.
 2           // <change cr="ArchCR00066.004" type="add">Add UmlPackagePath
 3           // qualifier values to CIM Schema.</change>
 4           // ==================================================================
 5           //  CIM_BufferPool 
 6           // ==================================================================
 7              [Version ( "2.6.0" ), 
 8               UMLPackagePath ( "CIM::Network::Buffers" ), 
 9               Description ( 
10                  "This class represents the use of buffers by a Queuing Service. "
11                  "The existence and management of individual buffers will be "
12                  "modeled in a future release. At the current level of "
13                  "abstraction, modeling the existence of the BufferPool is "
14                  "necessary. Long term, it is not sufficient. \n"
15                  "\n"
16                  "In implementations where there are multiple buffer sizes, an "
17                  "instance of BufferPool should be defined for each set of "
18                  "buffers with identical or similar sizes. These instances of "
19                  "buffer pools can then be grouped together using the "
20                  "CollectedBuffersPool association. \n"
21                  "\n"
22 marek 1.1        "Note that this class is derived from CollectionOfMSEs, and not "
23                  "from Forwarding or ConditioningService. BufferPool is only a "
24                  "collection of storage, and is NOT a Service." )]
25           class CIM_BufferPool : CIM_CollectionOfMSEs {
26           
27                 [Key, Override ( "CollectionID" ), 
28                  Description ( 
29                     "This property is defined in the CollectionOfMSEs class, "
30                     "but is overridden here to serve as part of the "
31                     "(composite) key that identifies the BufferPool instance." ), 
32                  MaxLen ( 256 )]
33              string CollectionID;
34           
35                 [Key, Description ( 
36                     "CreationClassName indicates the name of the class or the "
37                     "subclass used in the creation of an instance. When used "
38                     "with the other key properties of this class, this "
39                     "property allows all instances of this class and its "
40                     "subclasses to be uniquely identified." ), 
41                  MaxLen ( 256 )]
42              string CreationClassName;
43 marek 1.1 
44                 [Description ( 
45                     "The Name property defines the label by which the object is known."
46                      ), 
47                  MaxLen ( 256 )]
48              string Name;
49           
50                 [Deprecated { "CIM_BufferPool.SizeOfBuffers" }, 
51                  Description ( 
52                     "This property is a 16-bit unsigned integer, and defines "
53                     "the number of bytes in each buffer. It is deprecated in "
54                     "lieu of a similar uint32 property." ), 
55                  Units ( "Bytes" )]
56              uint16 BufferSize;
57           
58                 [Description ( 
59                     "This property is a 32-bit unsigned integer, and defines "
60                     "the number of bytes in each buffer." ), 
61                  Units ( "Bytes" )]
62              uint32 SizeOfBuffers;
63           
64 marek 1.1       [Description ( 
65                     "This property is a 32-bit unsigned integer, and defines "
66                     "the total number of buffers in the Pool." )]
67              uint32 TotalBuffers;
68           
69                 [Description ( 
70                     "This property is a 32-bit unsigned integer, and defines "
71                     "the number of buffers in the Pool that are currently not "
72                     "allocated to any instance of a QueuingService. Buffers "
73                     "allocated to a QueuingService could either be in use "
74                     "(containing packet data), or allocated to a Queue "
75                     "pending the arrival of new packet data." )]
76              uint32 AvailableBuffers;
77           
78                 [Description ( 
79                     "This property is a 32-bit unsigned integer, and defines "
80                     "the number of buffers in the Pool that have been "
81                     "simultaneously allocated to multiple instances of "
82                     "QueuingService." )]
83              uint32 SharedBuffers;
84           
85 marek 1.1 
86           };