8 .SH NAME
9 dat_ia_query \- query an IA
10 .SH SYNOPSIS
11 .LP
12 .nf
13 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-ldat\fR [ \fIlibrary\fR\&.\|.\|. ]
14 #include <\fBdat/udat.h\fR>
15
16 DAT_RETURN
17 dat_ia_query (
18 IN DAT_IA_HANDLE \fIia_handle\fR,
19 OUT DAT_EVD_HANDLE *\fIasync_evd_handle\fR,
20 IN DAT_IA_ATTR_MASK \fIia_attr_mask\fR,
21 OUT DAT_IA_ATTR *\fIia_attributes\fR,
22 IN DAT_PROVIDER_ATTR_MASK \fIprovider_attr_mask\fR,
23 OUT DAT_PROVIDER_ATTR *\fIprovider_attributes\fR
24 )
25 .fi
26
27 .SH PARAMETERS
28 .sp
29 .ne 2
30 .na
31 \fB\fIia_handle\fR\fR
32 .ad
33 .RS 23n
34 Handle for an open instance of an IA.
35 .RE
36
37 .sp
38 .ne 2
39 .na
40 \fB\fIasync_evd_handle\fR\fR
41 .ad
42 .RS 23n
43 Handle for an Event Dispatcher for asynchronous events generated by the IA.
44 .RE
45
46 .sp
47 .ne 2
48 .na
65 .sp
66 .ne 2
67 .na
68 \fB\fIprovider_attr_mask\fR\fR
69 .ad
70 .RS 23n
71 Mask for the \fIprovider_attributes\fR.
72 .RE
73
74 .sp
75 .ne 2
76 .na
77 \fB\fIprovider_attributes\fR\fR
78 .ad
79 .RS 23n
80 Pointer to a Consumer-allocated structure that the Provider fills with Provider
81 attributes.
82 .RE
83
84 .SH DESCRIPTION
85 .sp
86 .LP
87 The \fBdat_ia_query()\fR functions provides the Consumer with the IA
88 parameters, as well as the IA and Provider attributes. Consumers pass in
89 pointers to Consumer-allocated structures for the IA and Provider attributes
90 that the Provider fills.
91 .sp
92 .LP
93 The \fIia_attr_mask\fR and \fIprovider_attr_mask\fR parameters allow the
94 Consumer to specify which attributes to query. The Provider returns values for
95 requested attributes. The Provider can also return values for any of the other
96 attributes.
97 .SS "Interface Adapter Attributes"
98 .sp
99 .LP
100 The IA attributes are common to all open instances of the IA. DAT defines a
101 method to query the IA attributes but does not define a method to modify them.
102 .sp
103 .LP
104 If IA is multiported, each port is presented to a Consumer as a separate IA.
105 .sp
106 .ne 2
107 .na
108 \fBAdapter name:\fR
109 .ad
110 .br
111 .na
112 \fB\fR
113 .ad
114 .sp .6
115 .RS 4n
116 The name of the IA controlled by the Provider. The same as \fIia_name_ptr\fR.
117 .RE
118
376 .ad
377 .sp .6
378 .RS 4n
379 Number of vendor-specific attributes.
380 .RE
381
382 .sp
383 .ne 2
384 .na
385 \fBVendor-specific attributes:\fR
386 .ad
387 .sp .6
388 .RS 4n
389 Array of vendor-specific attributes. Each entry has the format of
390 \fBDAT_NAMED_ATTR\fR, which is a structure with two elements. The first element
391 is the name of the attribute. The second element is the value of the attribute
392 as a string.
393 .RE
394
395 .SS "DAPL Provider Attributes"
396 .sp
397 .LP
398 The provider attributes are specific to the open instance of the IA. DAT
399 defines a method to query Provider attributes but does not define a method to
400 modify them.
401 .sp
402 .ne 2
403 .na
404 \fBProvider name:\fR
405 .ad
406 .sp .6
407 .RS 4n
408 Name of the Provider vendor.
409 .RE
410
411 .sp
412 .ne 2
413 .na
414 \fBProvider version major:\fR
415 .ad
416 .sp .6
571 .RE
572
573 .sp
574 .ne 2
575 .na
576 \fBPZ support:\fR
577 .ad
578 .sp .6
579 .RS 4n
580 Indicator of what kind of protection the Provider's PZ provides.
581 .RE
582
583 .sp
584 .ne 2
585 .na
586 \fBOptimal Buffer Alignment:\fR
587 .ad
588 .sp .6
589 .RS 4n
590 Local and remote DTO buffer alignment for optimal performance on the Platform.
591 The \fBDAT_OPTIMAL_ALIGMNEMT\fR must be divisible by this attribute value. The
592 maximum allowed value is \fBDAT_OPTIMAL_ALIGMNEMT\fR, or 256.
593 .RE
594
595 .sp
596 .ne 2
597 .na
598 \fBEVD stream merging support:\fR
599 .ad
600 .sp .6
601 .RS 4n
602 A 2D binary matrix where each row and column represent an event stream type.
603 Each binary entry is 1 if the event streams of its row and column can be fed to
604 the same EVD, and 0 otherwise.
605 .sp
606 More than two different event stream types can feed the same EVD if for each
607 pair of the event stream types the entry is 1.
608 .sp
609 The Provider should support merging of all event stream types.
610 .sp
611 The Consumer should check this attribute before requesting an EVD that merges
612 multiple event stream types.
619 .ad
620 .sp .6
621 .RS 4n
622 Number of Provider-specific attributes.
623 .RE
624
625 .sp
626 .ne 2
627 .na
628 \fBProvider-specific attributes:\fR
629 .ad
630 .sp .6
631 .RS 4n
632 Array of Provider-specific attributes. Each entry has the format of
633 \fBDAT_NAMED_ATTR\fR, which is a structure with two elements. The first element
634 is the name of the attribute. The second element is the value of the attribute
635 as a string.
636 .RE
637
638 .SH RETURN VALUES
639 .sp
640 .ne 2
641 .na
642 \fB\fBDAT_SUCCESS\fR\fR
643 .ad
644 .RS 25n
645 The operation was successful.
646 .RE
647
648 .sp
649 .ne 2
650 .na
651 \fB\fBDAT_INVALID_PARAMETER\fR\fR
652 .ad
653 .RS 25n
654 Invalid parameter;
655 .RE
656
657 .sp
658 .ne 2
659 .na
660 \fB\fBDAT_INVALID_HANDLE\fR\fR
661 .ad
662 .RS 25n
663 Invalid DAT handle; ia_handle is invalid.
664 .RE
665
666 .SH ATTRIBUTES
667 .sp
668 .LP
669 See \fBattributes\fR(5) for descriptions of the following attributes:
670 .sp
671
672 .sp
673 .TS
674 box;
675 c | c
676 l | l .
677 ATTRIBUTE TYPE ATTRIBUTE VALUE
678 _
679 Interface Stability Standard: uDAPL, 1.1, 1.2
680 _
681 MT-Level Safe
682 .TE
683
684 .SH SEE ALSO
685 .sp
686 .LP
687 \fBlibdat\fR(3LIB), \fBattributes\fR(5)
|
8 .SH NAME
9 dat_ia_query \- query an IA
10 .SH SYNOPSIS
11 .LP
12 .nf
13 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-ldat\fR [ \fIlibrary\fR\&.\|.\|. ]
14 #include <\fBdat/udat.h\fR>
15
16 DAT_RETURN
17 dat_ia_query (
18 IN DAT_IA_HANDLE \fIia_handle\fR,
19 OUT DAT_EVD_HANDLE *\fIasync_evd_handle\fR,
20 IN DAT_IA_ATTR_MASK \fIia_attr_mask\fR,
21 OUT DAT_IA_ATTR *\fIia_attributes\fR,
22 IN DAT_PROVIDER_ATTR_MASK \fIprovider_attr_mask\fR,
23 OUT DAT_PROVIDER_ATTR *\fIprovider_attributes\fR
24 )
25 .fi
26
27 .SH PARAMETERS
28 .ne 2
29 .na
30 \fB\fIia_handle\fR\fR
31 .ad
32 .RS 23n
33 Handle for an open instance of an IA.
34 .RE
35
36 .sp
37 .ne 2
38 .na
39 \fB\fIasync_evd_handle\fR\fR
40 .ad
41 .RS 23n
42 Handle for an Event Dispatcher for asynchronous events generated by the IA.
43 .RE
44
45 .sp
46 .ne 2
47 .na
64 .sp
65 .ne 2
66 .na
67 \fB\fIprovider_attr_mask\fR\fR
68 .ad
69 .RS 23n
70 Mask for the \fIprovider_attributes\fR.
71 .RE
72
73 .sp
74 .ne 2
75 .na
76 \fB\fIprovider_attributes\fR\fR
77 .ad
78 .RS 23n
79 Pointer to a Consumer-allocated structure that the Provider fills with Provider
80 attributes.
81 .RE
82
83 .SH DESCRIPTION
84 .LP
85 The \fBdat_ia_query()\fR functions provides the Consumer with the IA
86 parameters, as well as the IA and Provider attributes. Consumers pass in
87 pointers to Consumer-allocated structures for the IA and Provider attributes
88 that the Provider fills.
89 .sp
90 .LP
91 The \fIia_attr_mask\fR and \fIprovider_attr_mask\fR parameters allow the
92 Consumer to specify which attributes to query. The Provider returns values for
93 requested attributes. The Provider can also return values for any of the other
94 attributes.
95 .SS "Interface Adapter Attributes"
96 .LP
97 The IA attributes are common to all open instances of the IA. DAT defines a
98 method to query the IA attributes but does not define a method to modify them.
99 .sp
100 .LP
101 If IA is multiported, each port is presented to a Consumer as a separate IA.
102 .sp
103 .ne 2
104 .na
105 \fBAdapter name:\fR
106 .ad
107 .br
108 .na
109 \fB\fR
110 .ad
111 .sp .6
112 .RS 4n
113 The name of the IA controlled by the Provider. The same as \fIia_name_ptr\fR.
114 .RE
115
373 .ad
374 .sp .6
375 .RS 4n
376 Number of vendor-specific attributes.
377 .RE
378
379 .sp
380 .ne 2
381 .na
382 \fBVendor-specific attributes:\fR
383 .ad
384 .sp .6
385 .RS 4n
386 Array of vendor-specific attributes. Each entry has the format of
387 \fBDAT_NAMED_ATTR\fR, which is a structure with two elements. The first element
388 is the name of the attribute. The second element is the value of the attribute
389 as a string.
390 .RE
391
392 .SS "DAPL Provider Attributes"
393 .LP
394 The provider attributes are specific to the open instance of the IA. DAT
395 defines a method to query Provider attributes but does not define a method to
396 modify them.
397 .sp
398 .ne 2
399 .na
400 \fBProvider name:\fR
401 .ad
402 .sp .6
403 .RS 4n
404 Name of the Provider vendor.
405 .RE
406
407 .sp
408 .ne 2
409 .na
410 \fBProvider version major:\fR
411 .ad
412 .sp .6
567 .RE
568
569 .sp
570 .ne 2
571 .na
572 \fBPZ support:\fR
573 .ad
574 .sp .6
575 .RS 4n
576 Indicator of what kind of protection the Provider's PZ provides.
577 .RE
578
579 .sp
580 .ne 2
581 .na
582 \fBOptimal Buffer Alignment:\fR
583 .ad
584 .sp .6
585 .RS 4n
586 Local and remote DTO buffer alignment for optimal performance on the Platform.
587 The \fBDAT_OPTIMAL_ALIGNMENT\fR must be divisible by this attribute value. The
588 maximum allowed value is \fBDAT_OPTIMAL_ALIGNMENT\fR, or 256.
589 .RE
590
591 .sp
592 .ne 2
593 .na
594 \fBEVD stream merging support:\fR
595 .ad
596 .sp .6
597 .RS 4n
598 A 2D binary matrix where each row and column represent an event stream type.
599 Each binary entry is 1 if the event streams of its row and column can be fed to
600 the same EVD, and 0 otherwise.
601 .sp
602 More than two different event stream types can feed the same EVD if for each
603 pair of the event stream types the entry is 1.
604 .sp
605 The Provider should support merging of all event stream types.
606 .sp
607 The Consumer should check this attribute before requesting an EVD that merges
608 multiple event stream types.
615 .ad
616 .sp .6
617 .RS 4n
618 Number of Provider-specific attributes.
619 .RE
620
621 .sp
622 .ne 2
623 .na
624 \fBProvider-specific attributes:\fR
625 .ad
626 .sp .6
627 .RS 4n
628 Array of Provider-specific attributes. Each entry has the format of
629 \fBDAT_NAMED_ATTR\fR, which is a structure with two elements. The first element
630 is the name of the attribute. The second element is the value of the attribute
631 as a string.
632 .RE
633
634 .SH RETURN VALUES
635 .ne 2
636 .na
637 \fB\fBDAT_SUCCESS\fR\fR
638 .ad
639 .RS 25n
640 The operation was successful.
641 .RE
642
643 .sp
644 .ne 2
645 .na
646 \fB\fBDAT_INVALID_PARAMETER\fR\fR
647 .ad
648 .RS 25n
649 Invalid parameter;
650 .RE
651
652 .sp
653 .ne 2
654 .na
655 \fB\fBDAT_INVALID_HANDLE\fR\fR
656 .ad
657 .RS 25n
658 Invalid DAT handle; ia_handle is invalid.
659 .RE
660
661 .SH ATTRIBUTES
662 .LP
663 See \fBattributes\fR(5) for descriptions of the following attributes:
664 .sp
665
666 .sp
667 .TS
668 box;
669 c | c
670 l | l .
671 ATTRIBUTE TYPE ATTRIBUTE VALUE
672 _
673 Interface Stability Standard: uDAPL, 1.1, 1.2
674 _
675 MT-Level Safe
676 .TE
677
678 .SH SEE ALSO
679 .LP
680 \fBlibdat\fR(3LIB), \fBattributes\fR(5)
|