1 a.dunfey 1.1 // ===================================================================
  2              // Title: Network_Buffers
  3              // $State: Exp $
  4              // $Date: 2004/11/29 18:31:42 $
  5              // $RCSfile: Network_Buffers.mof,v $
  6              // $Revision: 1.4.2.3 $
  7              // ===================================================================
  8              //#pragma inLine ("Includes/copyright.inc")
  9              // Copyright 1998-2005 Distributed Management Task Force, Inc. (DMTF).
 10              // All rights reserved.
 11              // DMTF is a not-for-profit association of industry members dedicated
 12              // to promoting enterprise and systems management and interoperability.
 13              // DMTF specifications and documents may be reproduced for uses
 14              // consistent with this purpose by members and non-members,
 15              // provided that correct attribution is given.
 16              // As DMTF specifications may be revised from time to time,
 17              // the particular version and release date should always be noted.
 18              // 
 19              // Implementation of certain elements of this standard or proposed
 20              // standard may be subject to third party patent rights, including
 21              // provisional patent rights (herein "patent rights"). DMTF makes
 22 a.dunfey 1.1 // no representations to users of the standard as to the existence
 23              // of such rights, and is not responsible to recognize, disclose, or
 24              // identify any or all such third party patent right, owners or
 25              // claimants, nor for any incomplete or inaccurate identification or
 26              // disclosure of such rights, owners or claimants. DMTF shall have no
 27              // liability to any party, in any manner or circumstance, under any
 28              // legal theory whatsoever, for failure to recognize, disclose, or
 29              // identify any such third party patent rights, or for such party's
 30              // reliance on the standard or incorporation thereof in its product,
 31              // protocols or testing procedures. DMTF shall have no liability to
 32              // any party implementing such standard, whether such implementation
 33              // is foreseeable or not, nor to any patent owner or claimant, and shall
 34              // have no liability or responsibility for costs or losses incurred if
 35              // a standard is withdrawn or modified after publication, and shall be
 36              // indemnified and held harmless by any party implementing the
 37              // standard from any and all claims of infringement by a patent owner
 38              // for such implementations.
 39              // 
 40              // For information about patents held by third-parties which have
 41              // notified the DMTF that, in their opinion, such patent may relate to
 42              // or impact implementations of DMTF standards, visit
 43 a.dunfey 1.1 // http://www.dmtf.org/about/policies/disclosures.php.
 44              //#pragma inLine
 45              // ===================================================================
 46              // Description: The Network Model extends the management concepts to
 47              //              represent protocol interfaces and network/protocol
 48              //              services.  This file defines the classes to manage
 49              //              network buffers.
 50              // 
 51              //              The object classes below are listed in an order that
 52              //              avoids forward references. Required objects, defined
 53              //              by other working groups, are omitted.
 54              // ==================================================================
 55              // Change Log for v2.7
 56              // CR790 - Add classes to support MPLS
 57              // CR982 - MPLS classes remain as Experimental for CIM V2.8
 58              // Change Log for v2.8
 59              // CR1061 - Add MPLSBuffers and MPLSBufferEndpointBuffers classes
 60              // CR1191 - CIM_MPLSBuffers and CIM_MPLSEndpointBuffers remain
 61              // experimental
 62              //          in CIM v2.9
 63              // CR1217 - Deprecate BufferPool.BufferSize in lieu of a larger uint
 64 a.dunfey 1.1 // definition.
 65              // ===================================================================
 66              
 67              #pragma Locale ("en_US")
 68              
 69              
 70              // ===================================================================
 71              // BufferPool
 72              // ===================================================================
 73                 [Version ( "2.6.0" ), Description (
 74                     "This class represents the use of buffers by a Queuing Service. "
 75                     "The existence and management of individual buffers will be "
 76                     "modeled in a future release. At the current level of "
 77                     "abstraction, modeling the existence of the BufferPool is "
 78                     "necessary. Long term, it is not sufficient. \n"
 79                     "\n"
 80                     "In implementations where there are multiple buffer sizes, an "
 81                     "instance of BufferPool should be defined for each set of "
 82                     "buffers with identical or similar sizes. These instances of "
 83                     "buffer pools can then be grouped together using the "
 84                     "CollectedBuffersPool association. \n"
 85 a.dunfey 1.1        "\n"
 86                     "Note that this class is derived from CollectionOfMSEs, and not "
 87                     "from Forwarding or ConditioningService. BufferPool is only a "
 88                     "collection of storage, and is NOT a Service.")]
 89              class CIM_BufferPool : CIM_CollectionOfMSEs {
 90              
 91                    [Key, Override ( "CollectionID" ), Description (
 92                        "This property is defined in the CollectionOfMSEs class, but "
 93                        "is overridden here to serve as part of the (composite) key "
 94                        "that identifies the BufferPool instance."), 
 95                     MaxLen ( 256 )]
 96                 string CollectionID;
 97              
 98                    [Key, Description (
 99                        "CreationClassName indicates the name of the class or the "
100                        "subclass used in the creation of an instance. When used "
101                        "with the other key properties of this class, this property "
102                        "allows all instances of this class and its subclasses to be "
103                        "uniquely identified."), 
104                     MaxLen ( 256 )]
105                 string CreationClassName;
106 a.dunfey 1.1 
107                    [Description (
108                        "The Name property defines the label by which the object is "
109                        "known."), 
110                     MaxLen ( 256 )]
111                 string Name;
112              
113                    [Deprecated { "CIM_BufferPool.SizeOfBuffers" }, Description (
114                        "This property is a 16-bit unsigned integer, and defines the "
115                        "number of bytes in each buffer. It is deprecated in lieu of "
116                        "a similar uint32 property."), 
117                     Units ( "Bytes" )]
118                 uint16 BufferSize;
119              
120              
121                    [Description (
122                        "This property is a 32-bit unsigned integer, and defines the "
123                        "number of bytes in each buffer."), 
124                     Units ( "Bytes" )]
125                 uint32 SizeOfBuffers;
126              
127 a.dunfey 1.1 
128                    [Description (
129                        "This property is a 32-bit unsigned integer, and defines the "
130                        "total number of buffers in the Pool.")]
131                 uint32 TotalBuffers;
132              
133                    [Description (
134                        "This property is a 32-bit unsigned integer, and defines the "
135                        "number of buffers in the Pool that are currently not "
136                        "allocated to any instance of a QueuingService. Buffers "
137                        "allocated to a QueuingService could either be in use "
138                        "(containing packet data), or allocated to a Queue pending "
139                        "the arrival of new packet data.")]
140                 uint32 AvailableBuffers;
141              
142                    [Description (
143                        "This property is a 32-bit unsigned integer, and defines the "
144                        "number of buffers in the Pool that have been simultaneously "
145                        "allocated to multiple instances of QueuingService.")]
146                 uint32 SharedBuffers;
147              };
148 a.dunfey 1.1 
149              
150              // ==================================================================
151              // CollectedBufferPool
152              // ==================================================================
153                 [Association, Aggregation, Version ( "2.6.0" ), Description (
154                     "CIM_CollectedBufferPool is an aggregation association "
155                     "representing that a Pool may itself be contained in a 'higher "
156                     "level' Pool.")]
157              class CIM_CollectedBufferPool : CIM_MemberOfCollection {
158              
159                    [Aggregate, Override ( "Collection" ), Description (
160                        "The 'higher level' or parent Pool.")]
161                 CIM_BufferPool REF Collection;
162              
163                    [Override ( "Member" ), Description (
164                        "The 'collected' Pool.")]
165                 CIM_BufferPool REF Member;
166              };
167              
168              
169 a.dunfey 1.1 // ===================================================================
170              // end of file
171              // ===================================================================