diff options
Diffstat (limited to 'usr/src/man/man3dat/dat_rmr_bind.3dat')
| -rw-r--r-- | usr/src/man/man3dat/dat_rmr_bind.3dat | 67 |
1 files changed, 8 insertions, 59 deletions
diff --git a/usr/src/man/man3dat/dat_rmr_bind.3dat b/usr/src/man/man3dat/dat_rmr_bind.3dat index 6bd6ee3102..175188ff88 100644 --- a/usr/src/man/man3dat/dat_rmr_bind.3dat +++ b/usr/src/man/man3dat/dat_rmr_bind.3dat @@ -4,13 +4,13 @@ .\" 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] -.TH dat_rmr_bind 3DAT "16 Jul 2004" "SunOS 5.11" "Direct Access Transport Library Functions" +.TH DAT_RMR_BIND 3DAT "Jul 16, 2004" .SH NAME dat_rmr_bind \- bind the RMR to the specified memory region within an LMR .SH SYNOPSIS .LP .nf -cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-ldat\fR [ \fIlibrary\fR\&.\|.\|. ] +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-ldat\fR [ \fIlibrary\fR\&.\|.\|. ] #include <\fBdat/udat.h\fR> DAT_RETURN @@ -28,55 +28,45 @@ DAT_RETURN .SH PARAMETERS .sp .ne 2 -.mk .na \fB\fIrmr_handle\fR\fR .ad .RS 20n -.rt Handle for an RMR instance. .RE .sp .ne 2 -.mk .na \fB\fIlmr_triplet\fR\fR .ad .RS 20n -.rt A pointer to an \fIlmr_triplet\fR that defines the memory region of the LMR. .RE .sp .ne 2 -.mk .na \fB\fImem_privileges\fR\fR .ad .RS 20n -.rt Consumer-requested memory access privileges for the registered remote memory region. The Default value is \fBDAT_MEM_PRIV_NONE_FLAG\fR. The constant value \fBDAT_MEM_PRIV_ALL_FLAG\fR = 0x33, which specifies both Read and Write privileges, is also defined. Memory privilege definitions are as follows: .sp .ne 2 -.mk .na \fBRemote Read\fR .ad .RS 16n -.rt \fBDAT_MEM_PRIV_REMOTE_READ_FLAG\fR .sp .ne 2 -.mk .na \fB0x02\fR .ad .RS 8n -.rt Remote read access requested. .RE @@ -84,21 +74,17 @@ Remote read access requested. .sp .ne 2 -.mk .na \fBRemote Write\fR .ad .RS 16n -.rt \fBDAT_MEM_PRIV_REMOTE_WRITE_FLAG\fR .sp .ne 2 -.mk .na \fB0x20\fR .ad .RS 8n -.rt Remote write access requested. .RE @@ -108,54 +94,44 @@ Remote write access requested. .sp .ne 2 -.mk .na \fB\fIep_handle\fR\fR .ad .RS 20n -.rt Endpoint to which \fBdat_rmr_bind()\fR is posted. .RE .sp .ne 2 -.mk .na \fB\fIuser_cookie\fR\fR .ad .RS 20n -.rt User-provided cookie that is returned to a Consumer at the completion of the \fBdat_rmr_bind()\fR. Can be \fINULL\fR. .RE .sp .ne 2 -.mk .na \fB\fIcompletion_flags\fR\fR .ad .RS 20n -.rt Flags for RMR Bind. The default \fBDAT_COMPLETION_DEFAULT_FLAG\fR is 0. Flag definitions are as follows: .sp .ne 2 -.mk .na \fBCompletion Suppression\fR .ad .RS 30n -.rt \fBDAT_COMPLETION_SUPPRESS_FLAG\fR .sp .ne 2 -.mk .na \fB0x01\fR .ad .RS 8n -.rt Suppress successful Completion. .RE @@ -163,21 +139,17 @@ Suppress successful Completion. .sp .ne 2 -.mk .na \fBNotification of Completion\fR .ad .RS 30n -.rt \fB\fR\fBDAT_COMPLETION_UNSIGNALLED_FLAG\fR .sp .ne 2 -.mk .na \fB0x04\fR .ad .RS 8n -.rt Non-notification completion. Local Endpoint must be configured for Notification Suppression. .RE @@ -186,21 +158,17 @@ Suppression. .sp .ne 2 -.mk .na \fBBarrier Fence\fR .ad .RS 30n -.rt \fB\fR\fBDAT_COMPLETION_BARRIER_FENCE_FLAG\fR .sp .ne 2 -.mk .na \fB0x08\fR .ad .RS 8n -.rt Request for Barrier Fence. .RE @@ -210,12 +178,10 @@ Request for Barrier Fence. .sp .ne 2 -.mk .na \fB\fIrmr_context\fR\fR .ad .RS 20n -.rt New \fIrmr_context\fR for the bound RMR suitable to be shared with a remote host. .RE @@ -322,91 +288,75 @@ is immediately flushed to \fIrequest_evd_handle\fR. .SH RETURN VALUES .sp .ne 2 -.mk .na \fB\fBDAT_SUCCESS\fR\fR .ad .RS 30n -.rt The operation was successful. .RE .sp .ne 2 -.mk .na \fB\fBDAT_INSUFFICIENT_RESOURCES\fR\fR .ad .RS 30n -.rt The operation failed due to resource limitations. .RE .sp .ne 2 -.mk .na \fB\fBDAT_INVALID_PARAMETER\fR\fR .ad .RS 30n -.rt Invalid parameter. For example, the \fItarget_address\fR or \fIsegment_length\fR exceeded the limits of the existing LMR. .RE .sp .ne 2 -.mk .na \fB\fBDAT_INVALID_HANDLE\fR\fR .ad .RS 30n -.rt Invalid DAT handle. .RE .sp .ne 2 -.mk .na \fB\fBDAT_INVALID_STATE\fR\fR .ad .RS 30n -.rt Parameter in an invalid state. Endpoint was not in the a \fBDAT_EP_STATE_CONNECTED\fR or \fBDAT_EP_STATE_DISCONNECTED\fR state. .RE .sp .ne 2 -.mk .na \fB\fBDAT_MODEL_NOT_SUPPORTED\fR\fR .ad .RS 30n -.rt The requested Model was not supported by the Provider. .RE .sp .ne 2 -.mk .na \fB\fBDAT_PRIVILEGES_VIOLATION\fR\fR .ad .RS 30n -.rt Privileges violation for local or remote memory access. .RE .sp .ne 2 -.mk .na \fB\fBDAT_PROTECTION_VIOLATION\fR\fR .ad .RS 30n -.rt Protection violation for local or remote memory access. .RE @@ -418,15 +368,14 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -Interface StabilityStandard: uDAPL, 1.1, 1.2 +Interface Stability Standard: uDAPL, 1.1, 1.2 _ -MT-LevelUnsafe +MT-Level Unsafe .TE .SH SEE ALSO |