share/man/man3dat/dat_cr_handoff.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_HANDOFF 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_cr_handoff \- hand off the Connection Request to another Service Point
  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_handoff (
  18     IN    DAT_CR_HANDLE    cr_handle,
  19     IN    DAT_CONN_QUAL    handoff
  20     )
  21 .fi
  22
  23 .SH PARAMETERS
  24 .sp
  25 .ne 2
  26 .na
  27 \fB\fIcr_handle\fR\fR
  28 .ad
  29 .RS 13n
  30 Handle to an instance of a Connection Request that the Consumer is handing off.
  31 .RE
  32
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fIhandoff\fR\fR
  37 .ad
  38 .RS 13n
  39 Indicator of another Connection Qualifier on the same IA to which this
  40 Connection Request should be handed off.
  41 .RE
  42
  43 .SH DESCRIPTION
  44 .sp
  45 .LP
  46 The \fBdat_cr_handoff()\fR function hands off the Connection Request to another
  47 Service Point specified by the Connection Qualifier \fIhandoff\fR.
  48 .sp
  49 .LP
  50 The operation is synchronous. This operation also destroys the Connection
  51 Request instance. Use of the handle of the destroyed Connection Request in any
  52 consequent operation fails.
  53 .SH RETURN VALUES
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fBDAT_SUCCESS\fR\fR
  58 .ad
  59 .RS 25n
  60 The operation was successful.
  61 .RE
  62
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fBDAT_INVALID_HANDLE\fR\fR
  67 .ad
  68 .RS 25n
  69 The \fIcr_handle\fR parameter is invalid.
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fBDAT_INVALID_PARAMETER\fR\fR
  76 .ad
  77 .RS 25n
  78 The \fIhandoff\fR parameter is invalid.
  79 .RE
  80
  81 .SH ATTRIBUTES
  82 .sp
  83 .LP
  84 See \fBattributes\fR(5) for descriptions of the following attributes:
  85 .sp
  86
  87 .sp
  88 .TS
  89 box;
  90 c | c
  91 l | l .
  92 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  93 _
  94 Interface Stability     Standard: uDAPL, 1.1, 1.2
  95 _
  96 MT-Level        Unsafe
  97 .TE
  98
  99 .SH SEE ALSO
 100 .sp
 101 .LP
 102 \fBlibdat\fR(3LIB), \fBattributes\fR(5)