-
Notifications
You must be signed in to change notification settings - Fork 2
/
cmpift.h
3355 lines (2845 loc) · 121 KB
/
cmpift.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* cmpift.h
*
* (C) Copyright IBM Corp. 2005
*
* THIS FILE IS PROVIDED UNDER THE TERMS OF THE ECLIPSE PUBLIC LICENSE
* ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS FILE
* CONSTITUTES RECIPIENTS ACCEPTANCE OF THE AGREEMENT.
*
* You can obtain a current copy of the Eclipse Public License from
* http://www.opensource.org/licenses/eclipse-1.0.php
*
* Author: Adrian Schuur <schuur@de.ibm.com>
*
* Description:
*
* CMPI function tables.
*
*/
/* ------------------------------------------------------------------------- */
/* */
/* Copyright (c) 2006 The Open Group */
/* */
/* Permission is hereby granted, free of charge, to any person obtaining a */
/* copy of this software (the "Software"), to deal in the Software without */
/* restriction, including without limitation the rights to use, copy, */
/* modify, merge, publish, distribute, sublicense, and/or sell copies of */
/* the Software, and to permit persons to whom the Software is furnished */
/* to do so, subject to the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be included */
/* in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS */
/* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT */
/* OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR */
/* THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/* */
/* ------------------------------------------------------------------------- */
#ifndef _CMPIFT_H_
# define _CMPIFT_H_
# include "cmpidt.h"
# include "cmpios.h"
# ifdef __cplusplus
extern "C"
{
# endif
//---------------------------------------------------
//--
// _CMPIBrokerEncFT Function Table
//--
//---------------------------------------------------
/** This structure is a table of pointers to broker and factory services
of encapsulated CMPIObjects. This table is made available
by the Management Broker, aka CIMOM, whenever a provider
is loaded and initialized.
*/
struct _CMPIBrokerEncFT
{
/** Function table version
*/
int ftVersion;
/** Instance factory service.
@param mb Pointer to the broker.
@param op ObjectPath containing namespace and classname.
@param rc Output: Service return status (suppressed when NULL).
@return The newly created Instance.
*/
CMPIInstance *(*newInstance)
(const CMPIBroker * mb, const CMPIObjectPath * op, CMPIStatus * rc);
/** ObjectPath factory service.
@param mb Pointer to the broker.
@param ns Namespace
@param cn Classname.
@param rc Output: Service return status (suppressed when NULL).
@return The newly created ObjectPath.
*/
CMPIObjectPath *(*newObjectPath)
(const CMPIBroker * mb, const char *ns, const char *cn,
CMPIStatus * rc);
/** Args container factory service.
@param mb Pointer to the broker.
@param rc Output: Service return status (suppressed when NULL).
@return The newly created Args container.
*/
CMPIArgs *(*newArgs) (const CMPIBroker * mb, CMPIStatus * rc);
/** String container factory service.
@param mb Pointer to the broker.
@param data String data
@param rc Output: Service return status (suppressed when NULL).
@return The newly created String.
*/
CMPIString *(*newString)
(const CMPIBroker * mb, const char *data, CMPIStatus * rc);
/** Array container factory service.
@param mb Pointer to the broker.
@param max Maximum number of elements
@param type Element type
@param rc Output: Service return status (suppressed when NULL).
@return The newly created Array.
*/
CMPIArray *(*newArray)
(const CMPIBroker * mb, CMPICount max, CMPIType type, CMPIStatus * rc);
/** DateTime factory service. Initialized with the time of day.
@param mb Pointer to the broker.
@param rc Output: Service return status (suppressed when NULL).
@return The newly created DateTime.
*/
CMPIDateTime *(*newDateTime) (const CMPIBroker * mb, CMPIStatus * rc);
/** DateTime factory service. Initialized from <binTime>.
@param mb Pointer to the broker.
@param binTime Date/Time definition in binary format in microsecods
starting since 00:00:00 GMT, Jan 1,1970.
@param interval Wenn true, defines Date/Time definition to be an interval value
@param rc Output: Service return status (suppressed when NULL).
@return The newly created DateTime.
*/
CMPIDateTime *(*newDateTimeFromBinary)
(const CMPIBroker * mb, CMPIUint64 binTime, CMPIBoolean interval,
CMPIStatus * rc);
/** DateTime factory service. Is initialized from <utcTime>.
@param mb Pointer to the broker.
@param utcTime Date/Time definition in UTC format
@param rc Output: Service return status (suppressed when NULL).
@return The newly created DateTime.
*/
CMPIDateTime *(*newDateTimeFromChars)
(const CMPIBroker * mb, const char *utcTime, CMPIStatus * rc);
/** SelectExp factory service.
@param mb Pointer to the broker.
@param query The select expression.
@param lang The query language.
@param projection Output: Projection specification (suppressed when NULL).
@param rc Output: Service return status (suppressed when NULL).
@return The newly created SelectExp.
*/
CMPISelectExp *(*newSelectExp)
(const CMPIBroker * mb, const char *query, const char *lang,
CMPIArray ** projection, CMPIStatus * st);
/** Function to determine whether a CIM class is of <type> or any of
<type> subclasses.
@param mb Pointer to the broker.
@param op The class path (namespace and classname components).
@param type The type to tested for.
@param rc Output: Service return status (suppressed when NULL).
@return True if test successful.
*/
CMPIBoolean (*classPathIsA)
(const CMPIBroker * mb, const CMPIObjectPath * op, const char *type,
CMPIStatus * rc);
/** Attempts to transforms an CMPI object to a broker specific string format.
Intended for debugging purposes only.
@param mb Pointer to the broker.
@param object A valid CMPI object.
@param rc Output: Service return status (suppressed when NULL).
@return String from representation of <object>.
*/
CMPIString *(*toString)
(const CMPIBroker * mb, const void *object, CMPIStatus * rc);
/** Verifies whether <object> is of CMPI type <type>.
Intended for debugging purposes only.
@param mb Pointer to the broker.
@param object A valid CMPI object.
@param type A string specifying a valid CMPI Object type
("CMPIInstance", "CMPIObjectPath", etc).
@param rc Output: Service return status (suppressed when NULL).
@return True if test successful.
*/
CMPIBoolean (*isOfType)
(const CMPIBroker * mb, const void *object, const char *type,
CMPIStatus * rc);
/** Retrieves the CMPI type of <object>.
Intended for debugging purposes only.
@param mb Pointer to the broker.
@param object A valid CMPI object.
@param rc Output: Service return status (suppressed when NULL).
@return CMPI object type.
*/
CMPIString *(*getType)
(const CMPIBroker * mb, const void *object, CMPIStatus * rc);
/** Retrieves translated message.
@param mb Pointer to the broker.
@param msgId The message identifier.
@param defMsg The default message.
@param rc Output: Service return status (suppressed when NULL).
@param count The number of message substitution values.
@return the trabslated message.
*/
CMPIString *(*getMessage)
(const CMPIBroker * mb, const char *msgId, const char *defMsg,
CMPIStatus * rc, CMPICount count, ...);
/** Logs a diagnostic message.
@param mb The mb argument points to a CMPIBroker structure.
@param severity The level argument describes the level of log message. Levels are defined in Section 4.9.
@param id The component argument, if not NULL, is the component ID.
@param text The text argument, if not NULL, is the message text to be logged.
@param string The string argument, if not NULL, is the message text to be logged. string will be
ignored when text is not NULL.
@return Service return status.
*/
CMPIStatus (*logMessage)
(const CMPIBroker *, int severity, const char *id,
const char *text, const CMPIString * string);
/** Logs a trace entry. Intended for debugging purposes.
@param mb The mb argument points to a CMPIBroker structure.
@param level The level argument describes the level of log message. Levels are defined in Section 4.9.
@param component The component argument, if not NULL, is the component ID.
@param text The text argument, if not NULL, is the message text to be logged.
@param string The string argument, if not NULL, is the message text to be logged. string will be
ignored when text is not NULL.
@return Service return status.
*/
CMPIStatus (*trace)
(const CMPIBroker *, int level, const char *component,
const char *text, const CMPIString * string);
# ifdef CMPI_VER_200
/** Error factory service.
@param mb Pointer to the broker.
@param msgID A string which uniquely identifies, within the scope of the 'owner' argument, the format of the message.
@param msg A string which represenst the formatted message.
@parem sev The percieved severity of the error.
@param pc The probably cause of this error
@param status Service return status.
@return The newly created Error.
*/
CMPIError* (*newCMPIError)
(const CMPIBroker*, const char*, const char*, const char*,
const CMPIErrorSeverity, const CMPIErrorProbableCause,const CMPIrc,
CMPIStatus *rc);
/** Opens a message file.
@param mb Broker this pointer
@param msgFile The message file identifier.
@param msgFileHandle Output: The handle representing the open message file.
@return Service return status.
*/
CMPIStatus (*openMessageFile)
(const CMPIBroker* mb, const char *msgFile,
CMPIMsgFileHandle* msgFileHandle);
/** Closes a message file.
@param mb Broker this pointer
@param msgFileHandle The handle representing the open message file.
@return Service return status.
*/
CMPIStatus (*closeMessageFile)
(const CMPIBroker* mb, const CMPIMsgFileHandle msgFileHandle);
/** Retrieves translated message.
@param mb Broker this pointer
@param msgId The message identifier.
@param msgFileHandle The handle representing the open message file.
@param defMsg The default message.
@param rc Output: Service return status (suppressed when NULL).
@param count The number of message substitution values.
@return the translated message.
*/
CMPIString* (*getMessage2)
(const CMPIBroker* mb, const char *msgId,
const CMPIMsgFileHandle msgFileHandle, const char *defMsg,
CMPIStatus* rc, CMPICount count, ...);
# endif /* CMPI_VER_200 */
};
//---------------------------------------------------
//--
// _CMPIBrokerFT Function Table
//--
//---------------------------------------------------
/** This structure is a table of pointers to broker CIMOM services
(up-calls). This table is made available by the Management Broker,
whenever a provider is loaded and initialized.
*/
struct _CMPIBrokerFT
{
/** 32 bits describing CMPI features supported by this CIMOM.
See CMPI_MB_Class_x and CMPI_MB_Supports_xxx flags.
*/
unsigned int brokerCapabilities;
/** CIMOM version as defined by CIMOM
*/
unsigned int brokerVersion;
/** CIMOM name
*/
const char *brokerName;
/** This function prepares the CMPI run time system to accept
a thread that will be using CMPI services. The returned
CMPIContext object must be used by the subsequent attachThread()
and detachThread() invocations.
@param mb Pointer to the broker.
@param ctx Old Context object
@return New Context object to be used by thread to be attached.
*/
CMPIContext *(*prepareAttachThread)
(const CMPIBroker * mb, const CMPIContext * ctx);
/** This function informs the CMPI run time system that the current
thread with Context will begin using CMPI services.
@param mb Pointer to the broker.
@param ctx Context object
@return Service return status.
*/
CMPIStatus (*attachThread) (const CMPIBroker *, const CMPIContext *);
/** This function informs the CMPI run time system that the current thread
will not be using CMPI services anymore. The Context object will be
freed during this operation.
@param mb Pointer to the broker.
@param ctx Context object
@return Service return status.
*/
CMPIStatus (*detachThread)
(const CMPIBroker * mb, const CMPIContext * ctx);
// class 0 services
/** This function requests delivery of an Indication. The CIMOM will
locate pertinent subscribers and notify them about the event.
@param mb Pointer to the broker.
@param ctx Context object
@param ns Namespace
@param ind Indication Instance
@return Service return status.
*/
CMPIStatus (*deliverIndication)
(const CMPIBroker * mb, const CMPIContext * ctx,
const char *ns, const CMPIInstance * ind);
// class 1 services
/** Enumerate Instance Names of the class (and subclasses) defined by <op>.
@param mb Pointer to the broker.
@param ctx Context object
@param op ObjectPath containing namespace and classname components.
@param rc Output: Service return status (suppressed when NULL).
@return Enumeration of ObjectPathes.
*/
CMPIEnumeration *(*enumerateInstanceNames)
(const CMPIBroker * mb, const CMPIContext * ctx,
const CMPIObjectPath * op, CMPIStatus * rc);
/** Get Instance using <op> as reference. Instance structure can be
controled using the CMPIInvocationFlags entry in <ctx>.
@param mb Pointer to the broker.
@param ctx Context object
@param op ObjectPath containing namespace, classname and key components.
@param properties If not NULL, the members of the array define one or more Property
names. Each returned Object MUST NOT include elements for any Properties
missing from this list
@param rc Output: Service return status (suppressed when NULL).
@return The Instance.
*/
CMPIInstance *(*getInstance)
(const CMPIBroker * mb, const CMPIContext * ctx,
const CMPIObjectPath * op, const char **properties, CMPIStatus * rc);
// class 2 services
/** Create Instance from <inst> using <op> as reference.
@param mb Pointer to the broker.
@param ctx Context object
@param op ObjectPath containing namespace, classname and key components.
@param inst Complete instance.
@param rc Output: Service return status (suppressed when NULL).
@return The assigned instance reference.
*/
CMPIObjectPath *(*createInstance)
(const CMPIBroker * mb, const CMPIContext * ctx,
const CMPIObjectPath * op, const CMPIInstance * inst, CMPIStatus * rc);
/** Replace an existing Instance from <inst> using <op> as reference.
@param mb Pointer to the broker.
@param ctx Context object
@param op ObjectPath containing namespace, classname and key components.
@param inst Complete instance.
@return Service return status.
*/
CMPIStatus (*modifyInstance)
(const CMPIBroker * mb, const CMPIContext * ctx,
const CMPIObjectPath * op, const CMPIInstance * inst,
const char **properties);
/** Delete an existing Instance using <op> as reference.
@param mb Pointer to the broker.
@param ctx Context object
@param op ObjectPath containing namespace, classname and key components.
@return Service return status.
*/
CMPIStatus (*deleteInstance)
(const CMPIBroker * mb, const CMPIContext * ctx,
const CMPIObjectPath * op);
/** Query the enumeration of instances of the class (and subclasses) defined
by <op> using <query> expression.
@param mb Pointer to the broker.
@param ctx Context object
@param op ObjectPath containing namespace and classname components.
@param query Query expression
@param lang Query Language
@param rc Output: Service return status (suppressed when NULL).
@return Resulting eumeration of Instances.
*/
CMPIEnumeration *(*execQuery)
(const CMPIBroker * mb, const CMPIContext * ctx,
const CMPIObjectPath * op, const char *query, const char *lang,
CMPIStatus * rc);
/** Enumerate Instances of the class (and subclasses) defined by <op>.
Instance structure and inheritance scope can be controled using the
CMPIInvocationFlags entry in <ctx>.
@param mb Pointer to the broker.
@param ctx Context object
@param op ObjectPath containing namespace and classname components.
@param properties If not NULL, the members of the array define one or more Property
names. Each returned Object MUST NOT include elements for any Properties
missing from this list
@param rc Output: Service return status (suppressed when NULL).
@return Enumeration of Instances.
*/
CMPIEnumeration *(*enumerateInstances)
(const CMPIBroker * mb, const CMPIContext * ctx,
const CMPIObjectPath * op, const char **properties, CMPIStatus * rc);
/** Enumerate instances associated with the Instance defined by the <op>.
@param mb Pointer to the broker.
@param ctx Context object
@param op Source ObjectPath containing namespace, classname and key components.
@param assocClass If not NULL, MUST be a valid Association Class name.
It acts as a filter on the returned set of Objects by mandating that
each returned Object MUST be associated to the source Object via an
Instance of this Class or one of its subclasses.
@param resultClass If not NULL, MUST be a valid Class name.
It acts as a filter on the returned set of Objects by mandating that
each returned Object MUST be either an Instance of this Class (or one
of its subclasses).
@param role If not NULL, MUST be a valid Property name.
It acts as a filter on the returned set of Objects by mandating
that each returned Object MUST be associated to the source Object
via an Association in which the source Object plays the specified role
(i.e. the name of the Property in the Association Class that refers
to the source Object MUST match the value of this parameter).
@param resultRole If not NULL, MUST be a valid Property name.
It acts as a filter on the returned set of Objects by mandating
that each returned Object MUST be associated to the source Object
via an Association in which the returned Object plays the specified role
(i.e. the name of the Property in the Association Class that refers to
the returned Object MUST match the value of this parameter).
@param properties If not NULL, the members of the array define one or more Property
names. Each returned Object MUST NOT include elements for any Properties
missing from this list
@param rc Output: Service return status (suppressed when NULL).
@return Enumeration of Instances.
*/
CMPIEnumeration *(*associators)
(const CMPIBroker * mb, const CMPIContext * ctx,
const CMPIObjectPath * op, const char *assocClass,
const char *resultClass, const char *role, const char *resultRole,
const char **properties, CMPIStatus * rc);
/** Enumerate ObjectPaths associated with the Instance defined by <op>.
@param mb Pointer to the broker.
@param ctx Context object
@param op Source ObjectPath containing namespace, classname and key components.
@param assocClass If not NULL, MUST be a valid Association Class name.
It acts as a filter on the returned set of Objects by mandating that
each returned Object MUST be associated to the source Object via an
Instance of this Class or one of its subclasses.
@param resultClass If not NULL, MUST be a valid Class name.
It acts as a filter on the returned set of Objects by mandating that
each returned Object MUST be either an Instance of this Class (or one
of its subclasses).
@param role If not NULL, MUST be a valid Property name.
It acts as a filter on the returned set of Objects by mandating
that each returned Object MUST be associated to the source Object
via an Association in which the source Object plays the specified role
(i.e. the name of the Property in the Association Class that refers
to the source Object MUST match the value of this parameter).
@param resultRole If not NULL, MUST be a valid Property name.
It acts as a filter on the returned set of Objects by mandating
that each returned Object MUST be associated to the source Object
via an Association in which the returned Object plays the specified role
(i.e. the name of the Property in the Association Class that refers to
the returned Object MUST match the value of this parameter).
@param rc Output: Service return status (suppressed when NULL).
@return Enumeration of ObjectPaths.
*/
CMPIEnumeration *(*associatorNames)
(const CMPIBroker * mb, const CMPIContext * ctx,
const CMPIObjectPath * op, const char *assocClass,
const char *resultClass, const char *role, const char *resultRole,
CMPIStatus * rc);
/** Enumerates the association instances that refer to the instance defined by
<op>.
@param mb Pointer to the broker.
@param ctx Context object
@param op Source ObjectPath containing namespace, classname and key components.
@param resultClass If not NULL, MUST be a valid Class name.
It acts as a filter on the returned set of Objects by mandating that
each returned Object MUST be either an Instance of this Class (or one
of its subclasses).
@param role If not NULL, MUST be a valid Property name.
It acts as a filter on the returned set of Objects by mandating
that each returned Object MUST be associated to the source Object
via an Association in which the source Object plays the specified role
(i.e. the name of the Property in the Association Class that refers
to the source Object MUST match the value of this parameter).
@param properties If not NULL, the members of the array define one or more Property
names. Each returned Object MUST NOT include elements for any Properties
missing from this list
@param rc Output: Service return status (suppressed when NULL).
@return Enumeration of ObjectPaths.
*/
CMPIEnumeration *(*references)
(const CMPIBroker * mb, const CMPIContext * ctx,
const CMPIObjectPath * op, const char *resultClass, const char *role,
const char **properties, CMPIStatus * rc);
/** Enumerates the association ObjectPaths that refer to the instance defined by
<op>.
@param mb Pointer to the broker.
@param ctx Context object
@param op Source ObjectPath containing namespace, classname and key components.
@param resultClass If not NULL, MUST be a valid Class name.
It acts as a filter on the returned set of Objects by mandating that
each returned Object MUST be either an Instance of this Class (or one
of its subclasses).
@param role If not NULL, MUST be a valid Property name.
It acts as a filter on the returned set of Objects by mandating
that each returned Object MUST be associated to the source Object
via an Association in which the source Object plays the specified role
(i.e. the name of the Property in the Association Class that refers
to the source Object MUST match the value of this parameter).
@param rc Output: Service return status (suppressed when NULL).
@return Enumeration of ObjectPaths.
*/
CMPIEnumeration *(*referenceNames)
(const CMPIBroker * mb, const CMPIContext * ctx,
const CMPIObjectPath * op, const char *resultClass, const char *role,
CMPIStatus * rc);
/** Invoke a named, extrinsic method of an Instance
defined by the <op> parameter.
@param mb Pointer to the broker.
@param ctx Context object
@param op ObjectPath containing namespace, classname and key components.
@param method Method name
@param in Input parameters.
@param out Output parameters.
@param rc Output: Service return status (suppressed when NULL).
@return Method return value.
*/
CMPIData (*invokeMethod)
(const CMPIBroker * mb, const CMPIContext * ctx,
const CMPIObjectPath * op, const char *method,
const CMPIArgs * in, CMPIArgs * out, CMPIStatus * rc);
/** Set the named property value of an Instance defined by the <op> parameter.
@param mb Pointer to the broker.
@param ctx Context object
@param op ObjectPath containing namespace, classname and key components.
@param name Property name
@param value Value.
@param type Value type.
@return Service return status.
*/
CMPIStatus (*setProperty)
(const CMPIBroker * mb, const CMPIContext * ctx,
const CMPIObjectPath * op, const char *name, const CMPIValue * value,
CMPIType type);
/** Get the named property value of an Instance defined by the <op> parameter.
@param mb Pointer to the broker.
@param ctx Context object
@param op ObjectPath containing namespace, classname and key components.
@param name Property name
@param rc Output: Service return status (suppressed when NULL).
@return Property value.
*/
CMPIData (*getProperty)
(const CMPIBroker * mb, const CMPIContext * ctx,
const CMPIObjectPath * op, const char *name, CMPIStatus * rc);
};
//---------------------------------------------------
//--
// _CMPIBrokerExtFT Function Table
//--
//---------------------------------------------------
struct timespec;
/** This structure is a table of pointers to extended broker CIMOM
services This table is made available by the Management Broker,
whenever a provider is loaded and initialized.
This is an extension used by Pegasus to support platform dependencies.
*/
struct _CMPIBrokerExtFT
{
/** Function table version
*/
int ftVersion;
/**
This function complements a generic dynamic library nameto its OS-dependent native format.
@param filename Pointer to the generic library name,
@return The returned char* pointer points to the complemented library name in native OS format.
Space for this string has been obtained using malloc() and must be released using free() by the caller.
In case no storage could be obtained for the complemented library name, NULL will be
returned.
*/
char *(*resolveFileName) (const char *filename);
/** Start a new thread using the POSIX threading semantics.
@param start Pointer to the function to be started as a thread.
@param param Pointer to the function to be started as a thread.
@param detached If not zero, defines that the thread should run in detached mode.
@return The return value is the thread ID.
*/
CMPI_THREAD_TYPE (*newThread)
(CMPI_THREAD_RETURN (CMPI_THREAD_CDECL * start) (void *), void *parm,
int detached);
/** Waits until the specified thread ends using the POSIX threading semantics.
@param thread The thread ID of the thread waiting for completion.
@param retval Pointer to the return value of the thread.
@return Completion code as defined by POSIX threading semantics (pthread_join)
*/
int (*joinThread) (CMPI_THREAD_TYPE thread, CMPI_THREAD_RETURN * retval);
/** Causes the current thread to exit with the passed in return code using POSIX threading semantics.
@param return_code Is the return code that should be used for the thread.
@return The function never exits.
*/
int (*exitThread) (CMPI_THREAD_RETURN return_code);
/** Cancel the thread using the POSIX threading semantics.
@param thread The thread to be canceled.
@return Completion code as defined by POSIX threading semantics (pthread_cancel)
*/
int (*cancelThread) (CMPI_THREAD_TYPE thread);
/** Suspends the execution of the current thread for the specified duration.
@param msec The suspend duration in milliseconds.
@return Completion code as defined by POSIX threading semantics (pthread_sleep)
*/
int (*threadSleep) (CMPIUint32 msec);
/** Executes the specified function procedure only once during the lifetime of the thread.
@param once The pointer to the counter.
@param The function to be called
@return Completion code as defined by POSIX threading semantics (pthread_once)
*/
int (*threadOnce) (int *once, void (*init) (void));
/* Create a POSIX threading conformant thread key. This key can be used as a key to access the thread local store.
@param key The address for the key to be returned.
@param cleanup Function to be invoked during thread local store cleanup.
@return Completion code as defined by POSIX threading semantics.
*/
int (*createThreadKey)
(CMPI_THREAD_KEY_TYPE * key, void (*cleanup) (void *));
/** Destroy a POSIX threading conformant thread key.
@param key The key to be destroyed.
@return Completion code as defined by POSIX threading semantics.
*/
int (*destroyThreadKey) (CMPI_THREAD_KEY_TYPE key);
/** Return data from the thread local store using a thread key.
@param key The key to be used to retrieve the data.
@return Completion code as defined by POSIX threading semantics.
*/
void *(*getThreadSpecific) (CMPI_THREAD_KEY_TYPE key);
/** Set a pointer to data in the therad local store using a thread key.
@param key The key to be used.
@param value The pointer to the data.
@return Completion code as defined by POSIX threading semantics.
*/
int (*setThreadSpecific) (CMPI_THREAD_KEY_TYPE key, void *value);
/** Create a POSIX threading conformant mutex.
@param opt The POSIX options. If not options are to be defined the 0 values must be used.
@return Handle of newly created mutex.
*/
CMPI_MUTEX_TYPE (*newMutex) (int opt);
/** Destroy a POSIX threading conformant mutex.
@param mutex The mutex to be destroyed.
*/
void (*destroyMutex) (CMPI_MUTEX_TYPE mutex);
/** Attempt to get control of the mutex and must wait until released when not available.
@param mutex The mutex to be locked.
*/
void (*lockMutex) (CMPI_MUTEX_TYPE mutex);
/** Release control of the mutex.
@param mutex The mutex to be unlocked.
*/
void (*unlockMutex) (CMPI_MUTEX_TYPE mutex);
/** Create a new POSIX threading-conformant condition variable.
@param opt The POSIX options. If not options are to be defined the 0 values must be used.
@return Handle of newly created condition variable.
*/
CMPI_COND_TYPE (*newCondition) (int opt);
/** Destroy a condition variable.
@param cond The condition variable to be destroyed.
*/
void (*destroyCondition) (CMPI_COND_TYPE cond);
/** Wait until condition is signalled. This function returns when condition has been
signalled already and otherwise must wait for the signal and then return.
@param cond The handle of the condition variable to be used.
@param mutex The handle of a locked mutex guarding this condition variable.
@return Return value As defined by POSIX threading specifications.
*/
int (*condWait) (CMPI_COND_TYPE cond, CMPI_MUTEX_TYPE mutex);
/** Wait until the condition is signalled using a timeout value. This
function shall return when condition has been signalled already and otherwise
must wait for the signal and then return. The function shall return when the
timeout specification elapses before the condition is signalled.
@param cond Specifies the handle of the condition variable to be used.
@param mutex Specifies the handle of a locked mutex guarding this condition variable.
@param wait Specifies the timeout value.
@return As defined by POSIX threading specifications.
*/
int (*timedCondWait)
(CMPI_COND_TYPE cond, CMPI_MUTEX_TYPE mutex, struct timespec * wait);
/** Sends a signal to a condition variable.
@param cond Specifies the handle of the condition variable to send the signal.
@return As defined by POSIX threading specifications.
*/
int (*signalCondition) (CMPI_COND_TYPE cond);
};
# if defined (CMPI_VER_200)
//---------------------------------------------------
//--
// _CMPIBroker Memory Function Table
//--
//---------------------------------------------------
/** This structure is a table of pointers to memory specific  CIMOM
services. This table is made available by the Management Broker,
whenever a provider is loaded and initialized.
This is an extension used by CIMOMs to support memory management
enhancements.
*/
struct _CMPIBrokerMemFT
{
const int ftVersion;
/** Returns a marker. Invoking this function marks subsequent newly
created CMPI objects to be released when release() function is invoked.
Note: mark() functions can be stacked.
@param mb The broker.
@param rc Output: Service return status (suppressed when NULL).
@return Handle to be provided to releae() function.
*/
CMPIGcStat *(*mark) (const CMPIBroker * mb, CMPIStatus * rc);
/** Release all CMPI objects created since last mark() operation
represented by the parameter. release() functions can be stacked.
@param mb The broker.
@param gc The handle returned from the mark() operation.
@return Service return status.
*/
CMPIStatus (*release) (const CMPIBroker * mb, const CMPIGcStat * gc);
/** Allocates uninitalized memory of the specified size.
@param mb Specifies the broker.
@param size Specifies the amount of memory to allocate.
@return Returns a pointer to the allocated memory, or NULL if the memory
could not be allocated
*/
void *(*cmpiMalloc) (const CMPIBroker * mb, size_t size);
/** This function shall return a pointer to the allocated memory, the
memory will be initialized to zero.
@param mb The broker.
@param nElems The number of elements to allocate.
@param sizeElem The number of elements to allocate.
@return Returns a pointer to the allocated memory, or NULL if the memory
could not be allocated
*/
void *(*cmpiCalloc) (const CMPIBroker * mb, size_t, size_t);
/** This function changes the size of the memory block pointed to by
ptr which must have been returned by a previous call to cmpiMalloc or
cmpiCalloc. See the ANSI-C function realloc for more information
@param mb the broker.
@param ptr Pointer to previosuly allocated memory. Passing a pointer
to this function which was not allocated explicitly by cmpiMalloc or
cmpiCalloc is undefined.
@param size The new size of the memory block.
@return Returns a pointer to the newly allocated memory block, or NULL
if the new memory is not allcoated. If the function fals nothing is
done with the original ptr argument.
*/
void *(*cmpiRealloc) (const CMPIBroker * mb, void *, size_t);
/** This function returns a pointer to a new string which is a
duplicate of the string src.
@param mb The broker
@param src The string to duplicate
@return a pointer to the duplicated string, or NULL if insufficient
memory was available.
*/
char *(*cmpiStrDup) (const CMPIBroker * mb, const char *);
/** This function frees memory allocated via the cmpiMalloc, cmpiCalloc
or cmpiRealloc functions.
@param mb The broker.
@param ptr The memory to free. This memory MUST have been allocated via
the cmpiMalloc, cmpiCalloc or cmpiRealloc functions.
@return None
*/
void (*cmpiFree) (const CMPIBroker * mb, void *);
/** Allows a MI to free memory associated to a CMPIinstance which was
allocated via CMPIBrokerEncFT.newInstance. this function should be
called when an instance is no longer being used by the MI. This
function will free all contained objects (e.g. properties).
@param mb the broker.
@parma inst The instance to free.
@return None
*/
void (*freeInstance) (const CMPIBroker * mb, CMPIInstance * inst);
/** Allows a MI to free memory associated to a CMPIArgs which was
allocated via CMPIBrokerEncFT.newArgs. this function should be called
when an instance is no longer being used by the MI. This function will
free all contained objects.
@param mb the broker.
@param obj The object path to free.
@return None
*/
void (*freeObjectPath) (const CMPIBroker * mb, CMPIObjectPath * obj);
/** Allows a MI to free memory associated to a CMPIArgs which was
allocated via CMPIBrokerEncFT.newArgs. this function should be called
when an instance is no longer being used by the MI. This function will
free all contained objects.
@param mb the broker.
@param args The argument to free.
@return None.
*/
void (*freeArgs) (const CMPIBroker * mb, CMPIArgs * args);
/** Allows a MI to free memory associated to a CMPIString which was
allocated via CMPIBrokerEncFT.newString. this function should be
called when an instance is no longer being used by the MI. This
function will free all contained objects.
@param mb the broker.
@param args The string to free.
@return None.
*/
void (*freeString) (const CMPIBroker * mb, CMPIString * str);
/** Allows a MI to free memory associated to a CMPIArray which was
allocated via CMPIBrokerEncFT.newArray. this function should be called
when an instance is no longer being used by the MI. This function will
free all contained objects (e.g. the array elements).
@param mb the broker.
@param args The string to free.
@return None.
*/
void (*freeArray) (const CMPIBroker * mb, CMPIArray * array);
/** Allows a MI to free memory associated to a CMPIDateTime which was
allocated via CMPIBrokerEncFT.newDateTime functions. this function
should be called when an instance is no longer being used by the MI.
This function will free all contained objects.
@param mb the broker.
@param args The string to free.
@return None.
*/
void (*freeDateTime) (const CMPIBroker * mb, CMPIDateTime * date);
/** Allows a MI to free memory associated to a CMPISelectExp which was
allocated via CMPIBrokerEncFT.newSelectExp functions. this function
should be called when an instance is no longer being used by the MI.
This function will free all contained objects.
@param mb the broker.
@param args The string to free.
@return None.
*/
void (*freeSelectExp) (const CMPIBroker * mb, CMPISelectExp * se);
};
# endif
//---------------------------------------------------
//--
// _CMPIBroker Encapsulated object
//--
//---------------------------------------------------
/** This structure represents the Management Broker (CIM Object Manager).
*/
struct _CMPIBroker
{
/** Opaque pointer to MB specific implementation data.
*/
void *hdl;
/** Pointer to MB service routines function table.
*/
CMPIBrokerFT *bft;
/** Pointer to MB factory service routines function table.
*/
CMPIBrokerEncFT *eft;
/** Pointer to MB extended services function table.
*/
CMPIBrokerExtFT *xft;
# ifdef CMPI_VER_200
/** Pointer to MB memory enhancements function table.
*/
CMPIBrokerMemFT *mft;
# endif
};
//---------------------------------------------------
//--
// _CMPIContext Function Table
//--
//---------------------------------------------------
/** This structure is a table of pointers providing access to Context
support sevices.
*/
struct _CMPIContextFT
{
/** Function table version
*/
int ftVersion;
/** The Context object will not be used any further and may be freed by
CMPI run time system.
@param ctx Context this pointer.
@return Service return status.
*/