usr/src/man/man3dat/dat_psp_free.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_PSP_FREE 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_psp_free \- destroy an instance of the Public 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_psp_free (
  18     IN    DAT_PSP_HANDLE    psp_handle
  19     )
  20 .fi
  21
  22 .SH PARAMETERS
  23 .sp
  24 .ne 2
  25 .na
  26 \fB\fIpsp_handle\fR\fR
  27 .ad
  28 .RS 14n
  29 Handle for an instance of the Public Service Point.
  30 .RE
  31
  32 .SH DESCRIPTION
  33 .sp
  34 .LP
  35 The \fBdat_psp_free()\fR function destroys a specified instance of the Public
  36 Service Point.
  37 .sp
  38 .LP
  39 Any incoming Connection Requests for the Connection Qualifier on the destroyed
  40 Service Point it had been listening on are automatically rejected by the
  41 Provider with the return analogous to the no listening Service Point.
  42 .sp
  43 .LP
  44 The behavior of the Connection Requests in progress is undefined and left to an
  45 implementation. But it must be consistent. This means that either a Connection
  46 Requested Event has been generated for the Event Dispatcher associated with the
  47 Service Point, including the creation of the Connection Request instance, or
  48 the Connection Request is rejected by the Provider without any local
  49 notification.
  50 .sp
  51 .LP
  52 This operation shall have no effect on previously generated Connection
  53 Requested Events. This includes Connection Request instances and, potentially,
  54 Endpoint instances created by the Provider.
  55 .sp
  56 .LP
  57 The behavior of this operation with creation of a Service Point on the same
  58 Connection Qualifier at the same time is not defined. Consumers are advised to
  59 avoid this scenario.
  60 .sp
  61 .LP
  62 Use of the handle of the destroyed Public Service Point in any consequent
  63 operation fails.
  64 .SH RETURN VALUES
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fBDAT_SUCCESS\fR\fR
  69 .ad
  70 .RS 22n
  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 22n
  80 The \fIpsp_handle\fR parameter is invalid.
  81 .RE
  82
  83 .SH ATTRIBUTES
  84 .sp
  85 .LP
  86 See \fBattributes\fR(5) for descriptions of the following attributes:
  87 .sp
  88
  89 .sp
  90 .TS
  91 box;
  92 c | c
  93 l | l .
  94 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  95 _
  96 Interface Stability     Standard: uDAPL, 1.1, 1.2
  97 _
  98 MT-Level        Unsafe
  99 .TE
 100
 101 .SH SEE ALSO
 102 .sp
 103 .LP
 104 \fBlibdat\fR(3LIB), \fBattributes\fR(5)