xref: /illumos-gate/usr/src/man/man3dat/dat_rmr_query.3dat (revision 5d9d9091f564c198a760790b0bfa72c44e17912b)
te
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]
DAT_RMR_QUERY 3DAT "Jul 16, 2004"
NAME
dat_rmr_query - provide RMR parameters
SYNOPSIS

cc [ flag.\|.\|. ] file.\|.\|. -ldat [ library.\|.\|. ]
#include <dat/udat.h>

DAT_RETURN
 dat_rmr_query (
 IN DAT_RMR_HANDLE rmr_handle,
 IN DAT_RMR_PARAM_MASK rmr_param_mask,
 OUT DAT_RMR_PARAM *rmr_param
 )
PARAMETERS
rmr_handle

Handle for an instance of the RMR.

rmr_param_mask

Mask for RMR parameters.

rmr_param

Pointer to a Consumer-allocated structure that the Provider fills with RMR parameters.

DESCRIPTION

The dat_rmr_query() function provides RMR parameters to the Consumer. The Consumer passes in a pointer to the Consumer-allocated structures for RMR parameters that the Provider fills.

The rmr_param_mask parameter allows Consumers to specify which parameters to query. The Provider returns values for rmr_param_mask requested parameters. The Provider can return values for any other parameters.

Not all parameters can have a value at all times. For example, lmr_handle, target_address, segment_length, mem_privileges, and rmr_context are not defined for an unbound RMR.

RETURN VALUES
DAT_SUCCESS

The operation was successful.

DAT_INVALID_PARAMETER

The rmr_param_mask parameter is invalid.

DAT_INVALID_HANDLE

The mr_handle parameter is invalid.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard: uDAPL, 1.1, 1.2
MT-Level Unsafe
SEE ALSO

libdat (3LIB), attributes (7)