This manual page is derived from the DAT/uDAPL 1.2 specification.
Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
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.
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.
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]
typedef struct dat_provider_info {
char ia_name[DAT_NAME_MAX_LENGTH];
DAT_UINT32 dapl_version_major;
DAT_UINT32 dapl_version_minor;
DAT_BOOLEAN is_thread_safe;
} DAT_PROVIDER_INFO;
cc [ flag.\|.\|. ] file.\|.\|. -ldat [ library.\|.\|. ]
#include <dat/udat.h>
DAT_RETURN
dat_registry_list_providers (
IN DAT_COUNT max_to_return,
OUT DAT_COUNT *number_entries,
OUT DAT_PROVIDER_INFO *(dat_provider_list[])
)
Maximum number of entries that can be returned to the Consumer in the dat_provider_list.
The actual number of entries returned to the Consumer in the dat_provider_list if successful or the number of Providers available.
Points to an array of DAT_PROVIDER_INFO pointers supplied by the Consumer. Each Provider's information will be copied to the destination specified.
The dat_registry_list_providers() function allows the Consumer to obtain a list of available Providers from the Static Registry. The information provided is the Interface Adapter name, the uDAPL/kDAPL API version supported, and whether the provided version is thread-safe. The Consumer can examine the attributes to determine which (if any) Interface Adapters it wants to open. This operation has no effect on the Registry itself.
The Registry can open an IA using a Provider whose dapl_version_minor is larger than the one the Consumer requests if no Provider entry matches exactly. Therefore, Consumers should expect that an IA can be opened successfully as long as at least one Provider entry returned by dat_registry_list_providers() matches the ia_name, dapl_version_major, and is_thread_safe fields exactly, and has a dapl_version_minor that is equal to or greater than the version requested.
If the operation is successful, the returned value is DAT_SUCCESS and number_entries indicates the number of entries filled by the registry in dat_provider_list.
If the operation is not successful, then number_entries returns the number of entries in the registry. Consumers can use this return to allocate dat_provider_list large enough for the registry entries. This number is just a snapshot at the time of the call and may be changed by the time of the next call. If the operation is not successful, then the content of dat_provider_list is not defined.
If dat_provider_list is too small, including pointing to NULL for the registry entries, then the operation fails with the return DAT_INVALID_PARAMETER.
The operation was successful.
Invalid parameter. For example, dat_provider_list is too small or NULL.
Internal error. The DAT static registry is missing.
DAT_NAME_MAX_LENGTH includes the null character for string termination.
See attributes(5) for descriptions of the following attributes:
| ATTRIBUTE TYPE ATTRIBUTE VALUE |
| Interface Stability Standard: uDAPL, 1.1, 1.2 |
| MT-Level Safe |
libdat(3LIB), attributes(5)