xref: /titanic_51/usr/src/man/man3dat/dat_rmr_create.3dat (revision 89b43686db1fe9681d80a7cf5662730cb9378cae)
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_create 3DAT "16 Jul 2004" "SunOS 5.11" "Direct Access Transport Library Functions"
NAME
dat_rmr_create - create an RMR for the specified Protection Zone
SYNOPSIS

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

DAT_RETURN
 dat_rmr_create(
 IN DAT_PZ_HANDLE pz_handle,
 OUT DAT_RMR_HANDLE *rmr_handle
 )
PARAMETERS

pz_handle

Handle for an instance of the Protection Zone.

rmr_handle

Handle for the created instance of an RMR.

DESCRIPTION

The dat_rmr_create() function creates an RMR for the specified Protection Zone. This operation is relatively heavy. The created RMR can be bound to a memory region within the LMR through a lightweight dat_rmr_bind(3DAT) operation that generates rmr_context.

If the operation fails (does not return DAT_SUCCESS), the return values of rmr_handle are undefined and Consumers should not use them.

The pz_handle parameter provide Consumers a way to restrict access to an RMR by authorized connection only.

RETURN VALUES

DAT_SUCCESS

The operation was successful.

DAT_INSUFFICIENT_RESOURCES

The operation failed due to resource limitations.

DAT_INVALID_HANDLE

The pz_handle parameter is invalid.

ATTRIBUTES

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

ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityStandard: uDAPL, 1.1, 1.2
MT-LevelSafe
SEE ALSO

dat_rmr_bind(3DAT) , libdat(3LIB), attributes(5)