share/man/man3dat/dat_cr_query.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_CR_QUERY 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_cr_query \- provide parameters of the Connection Request
  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_cr_query (
  18     IN    DAT_CR_HANDLE        cr_handle,
  19     IN    DAT_CR_PARAM_MASK    cr_param_mask,
  20     OUT   DAT_CR_PARAM         *cr_param
  21     )
  22 .fi
  23
  24 .SH PARAMETERS
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fIcr_handle\fR\fR
  29 .ad
  30 .RS 17n
  31 Handle for an instance of a Connection Request.
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIcr_param_mask\fR\fR
  38 .ad
  39 .RS 17n
  40 Mask for Connection Request parameters.
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fIcr_param\fR\fR
  47 .ad
  48 .RS 17n
  49 Pointer to a Consumer-allocated structure that the Provider fills for
  50 Consumer-requested parameters.
  51 .RE
  52
  53 .SH DESCRIPTION
  54 .sp
  55 .LP
  56 The \fBdat_cr_query()\fR function provides to the Consumer parameters of the
  57 Connection Request. The Consumer passes in a pointer to the Consumer-allocated
  58 structures for Connection Request parameters that the Provider fills.
  59 .sp
  60 .LP
  61 The \fIcr_param_mask\fR parameter allows Consumers to specify which parameters
  62 to query. The Provider returns values for \fIcr_param_mask\fR requested
  63 parameters. The Provider can return values for any other parameters.
  64 .SH RETURN VALUES
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fBDAT_SUCCESS\fR\fR
  69 .ad
  70 .RS 25n
  71 The operation was successful
  72 .RE
  73
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fBDAT_INVALID_HANDLE\fR\fR
  78 .ad
  79 .RS 25n
  80 The \fIcr_handle\fR handle is invalid.
  81 .RE
  82
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fBDAT_INVALID_PARAMETER\fR\fR
  87 .ad
  88 .RS 25n
  89 The \fIcr_param_mask\fR parameter is invalid.
  90 .RE
  91
  92 .SH USAGE
  93 .sp
  94 .LP
  95 The Consumer uses \fBdat_cr_query()\fR to get information about requesting a
  96 remote Endpoint as well as a local Endpoint if it was allocated by the Provider
  97 for the arrived Connection Request. The local Endpoint is created if the
  98 Consumer used PSP with \fBDAT_PSP_PROVIDER\fR as the value for \fIpsp_flags\fR.
  99 For the remote Endpoint, \fBdat_cr_query()\fR  provides \fIremote_ia_address\fR
 100 and \fIremote_port_qual\fR. It also provides remote \fIpeer private_data\fR and
 101 its size.
 102 .SH ATTRIBUTES
 103 .sp
 104 .LP
 105 See \fBattributes\fR(5) for descriptions of the following attributes:
 106 .sp
 107
 108 .sp
 109 .TS
 110 box;
 111 c | c
 112 l | l .
 113 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 114 _
 115 Interface Stability     Standard: uDAPL, 1.1, 1.2
 116 _
 117 MT-Level        Safe
 118 .TE
 119
 120 .SH SEE ALSO
 121 .sp
 122 .LP
 123 \fBlibdat\fR(3LIB), \fBattributes\fR(5)