usr/src/man/man3dat/dat_registry_list_providers.3dat

   1 '\" te
   2 .\" This manual page is derived from the DAT/uDAPL 1.2 specification.
   3 .\" Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH DAT_REGISTRY_LIST_PROVIDERS 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_registry_list_providers \- obtain a list of available pProviders from the
  10 Static Registry
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 typedef struct dat_provider_info {
  15     char ia_name[DAT_NAME_MAX_LENGTH];
  16     DAT_UINT32      dapl_version_major;
  17     DAT_UINT32      dapl_version_minor;
  18     DAT_BOOLEAN     is_thread_safe;
  19     } DAT_PROVIDER_INFO;
  20
  21 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-ldat\fR [ \fIlibrary\fR\&.\|.\|. ]
  22 #include <\fBdat/udat.h\fR>
  23
  24 DAT_RETURN
  25     dat_registry_list_providers (
  26     IN    DAT_COUNT          max_to_return,
  27     OUT   DAT_COUNT          *number_entries,
  28     OUT   DAT_PROVIDER_INFO  *(dat_provider_list[])
  29     )
  30 .fi
  31
  32 .SH PARAMETERS
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fImax_to_return\fR\fR
  37 .ad
  38 .RS 21n
  39 Maximum number of entries that can be returned to the Consumer in the
  40 \fIdat_provider_list\fR.
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fInumber_entries\fR\fR
  47 .ad
  48 .RS 21n
  49 The actual number of entries returned to the Consumer in the
  50 \fIdat_provider_list\fR if successful or the number of Providers available.
  51 .RE
  52
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fIdat_provider_list\fR\fR
  57 .ad
  58 .RS 21n
  59 Points to an array of \fBDAT_PROVIDER_INFO\fR pointers supplied by the
  60 Consumer. Each Provider's information will be copied to the destination
  61 specified.
  62 .RE
  63
  64 .SH DESCRIPTION
  65 .sp
  66 .LP
  67 The \fBdat_registry_list_providers()\fR function allows the Consumer to obtain
  68 a list of available Providers from the Static Registry. The information
  69 provided is the Interface Adapter name, the uDAPL/kDAPL API version supported,
  70 and whether the provided version is thread-safe. The Consumer can examine the
  71 attributes to determine which (if any) Interface Adapters it wants to open.
  72 This operation has no effect on the Registry itself.
  73 .sp
  74 .LP
  75 The Registry can open an IA using a Provider whose \fIdapl_version_minor\fR is
  76 larger than the one the Consumer requests if no Provider entry matches exactly.
  77 Therefore, Consumers should expect that an IA can be opened successfully as
  78 long as at least one Provider entry returned by
  79 \fBdat_registry_list_providers()\fR matches the \fIia_name\fR,
  80 \fIdapl_version_major\fR, and \fIis_thread_safe\fR fields exactly, and has a
  81 \fIdapl_version_minor\fR that is equal to or greater than the version
  82 requested.
  83 .sp
  84 .LP
  85 If the operation is successful, the returned value is \fBDAT_SUCCESS\fR and
  86 \fInumber_entries\fR indicates the number of entries filled by the registry in
  87 \fIdat_provider_list\fR.
  88 .sp
  89 .LP
  90 If the operation is not successful, then \fInumber_entries\fR returns the
  91 number of entries in the registry. Consumers can use this return to allocate
  92 \fIdat_provider_list\fR large enough for the registry entries. This number is
  93 just a snapshot at the time of the call and may be changed by the time of the
  94 next call. If the operation is not successful, then the content of
  95 \fIdat_provider_list\fR is not defined.
  96 .sp
  97 .LP
  98 If \fIdat_provider_list\fR is too small, including pointing to \fINULL\fR for
  99 the registry entries, then the operation fails with the return
 100 \fBDAT_INVALID_PARAMETER\fR.
 101 .SH RETURN VALUES
 102 .sp
 103 .ne 2
 104 .na
 105 \fB\fBDAT_SUCCESS\fR\fR
 106 .ad
 107 .RS 25n
 108 The operation was successful.
 109 .RE
 110
 111 .sp
 112 .ne 2
 113 .na
 114 \fB\fBDAT_INVALID_PARAMETER\fR\fR
 115 .ad
 116 .RS 25n
 117 Invalid parameter. For example, \fIdat_provider_list\fR is too small or
 118 \fINULL\fR.
 119 .RE
 120
 121 .sp
 122 .ne 2
 123 .na
 124 \fB\fBDAT_INTERNAL_ERROR\fR\fR
 125 .ad
 126 .RS 25n
 127 Internal error. The DAT static registry is missing.
 128 .RE
 129
 130 .SH USAGE
 131 .sp
 132 .LP
 133 \fBDAT_NAME_MAX_LENGTH\fR includes the null character for string termination.
 134 .SH ATTRIBUTES
 135 .sp
 136 .LP
 137 See \fBattributes\fR(5) for descriptions of the following attributes:
 138 .sp
 139
 140 .sp
 141 .TS
 142 box;
 143 c | c
 144 l | l .
 145 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 146 _
 147 Interface Stability     Standard: uDAPL, 1.1, 1.2
 148 _
 149 MT-Level        Safe
 150 .TE
 151
 152 .SH SEE ALSO
 153 .sp
 154 .LP
 155 \fBlibdat\fR(3LIB), \fBattributes\fR(5)