usr/src/man/man3dat/dat_rmr_create.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_RMR_CREATE 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_rmr_create \- create an RMR for the specified Protection Zone
  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_rmr_create(
  18     IN    DAT_PZ_HANDLE     pz_handle,
  19     OUT   DAT_RMR_HANDLE    *rmr_handle
  20     )
  21 .fi
  22
  23 .SH PARAMETERS
  24 .sp
  25 .ne 2
  26 .na
  27 \fB\fIpz_handle\fR\fR
  28 .ad
  29 .RS 14n
  30 Handle for an instance of the Protection Zone.
  31 .RE
  32
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fIrmr_handle\fR\fR
  37 .ad
  38 .RS 14n
  39 Handle for the created instance of an RMR.
  40 .RE
  41
  42 .SH DESCRIPTION
  43 .sp
  44 .LP
  45 The \fBdat_rmr_create()\fR function creates an RMR for the specified Protection
  46 Zone. This operation is relatively heavy. The created RMR can be bound to a
  47 memory region within the LMR through a lightweight \fBdat_rmr_bind\fR(3DAT)
  48 operation that generates \fIrmr_context\fR.
  49 .sp
  50 .LP
  51 If the operation fails (does not return \fBDAT_SUCCESS\fR), the return values
  52 of \fIrmr_handle\fR are undefined and Consumers should not use them.
  53 .sp
  54 .LP
  55 The \fIpz_handle\fR parameter provide Consumers a way to restrict access to an
  56 RMR by authorized connection only.
  57 .SH RETURN VALUES
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fBDAT_SUCCESS\fR\fR
  62 .ad
  63 .RS 30n
  64 The operation was successful.
  65 .RE
  66
  67 .sp
  68 .ne 2
  69 .na
  70 \fB\fBDAT_INSUFFICIENT_RESOURCES\fR\fR
  71 .ad
  72 .RS 30n
  73 The operation failed due to resource limitations.
  74 .RE
  75
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fBDAT_INVALID_HANDLE\fR\fR
  80 .ad
  81 .RS 30n
  82 The \fIpz_handle\fR parameter is invalid.
  83 .RE
  84
  85 .SH ATTRIBUTES
  86 .sp
  87 .LP
  88 See \fBattributes\fR(5) for descriptions of the following attributes:
  89 .sp
  90
  91 .sp
  92 .TS
  93 box;
  94 c | c
  95 l | l .
  96 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  97 _
  98 Interface Stability     Standard: uDAPL, 1.1, 1.2
  99 _
 100 MT-Level        Safe
 101 .TE
 102
 103 .SH SEE ALSO
 104 .sp
 105 .LP
 106 \fBdat_rmr_bind\fR(3DAT) , \fBlibdat\fR(3LIB), \fBattributes\fR(5)