share/man/man3dat/dat_registry_add_provider.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_REGISTRY_ADD_PROVIDER 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_registry_add_provider \- declare the Provider with the Dynamic Registry
  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_registry_add_provider (
  18     IN    const DAT_PROVIDER          *provider,
  19     IN    const DAT_PROVIDER_INFO     *provider_info
  20     )
  21 .fi
  22
  23 .SH PARAMETERS
  24 .sp
  25 .ne 2
  26 .na
  27 \fB\fIprovider\fR\fR
  28 .ad
  29 .RS 17n
  30 Self-description of a Provider.
  31 .RE
  32
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fIprovider_info\fR\fR
  37 .ad
  38 .RS 17n
  39 Attributes of the Provider.
  40 .RE
  41
  42 .SH DESCRIPTION
  43 .sp
  44 .LP
  45 The Provider declares itself with the Dynamic Registry. Note that the caller
  46 can choose to register itself multiple times, for example once for each port.
  47 The choice of what to virtualize is up to the Provider. Each registration
  48 provides an Interface Adapter to DAT. Each Provider must have a unique name.
  49 .sp
  50 .LP
  51 The same IA Name cannot be added multiple times. An attempt to register the
  52 same IA Name again results in an error with the return value
  53 \fBDAT_PROVIDER_ALREADY_REGISTERED\fR.
  54 .sp
  55 .LP
  56 The contents of provider_info must be the same as those the Consumer uses in
  57 the call to \fBdat_ia_open\fR(3DAT) directly, or the ones provided indirectly
  58 defined by the header files with which the Consumer compiled.
  59 .SH RETURN VALUES
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fBDAT_SUCCESS\fR\fR
  64 .ad
  65 .sp .6
  66 .RS 4n
  67 The operation was successful.
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fBDAT_INSUFFICIENT_RESOURCES\fR\fR
  74 .ad
  75 .sp .6
  76 .RS 4n
  77 The maximum number of Providers was already registered.
  78 .RE
  79
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fBDAT_INVALID_PARAMETER\fR\fR
  84 .ad
  85 .sp .6
  86 .RS 4n
  87 Invalid parameter.
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fBDAT_PROVIDER_ALREADY_REGISTERED\fR\fR
  94 .ad
  95 .sp .6
  96 .RS 4n
  97 Invalid or nonunique name.
  98 .RE
  99
 100 .SH ATTRIBUTES
 101 .sp
 102 .LP
 103 See \fBattributes\fR(5) for descriptions of the following attributes:
 104 .sp
 105
 106 .sp
 107 .TS
 108 box;
 109 c | c
 110 l | l .
 111 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 112 _
 113 Interface Stability     Standard: uDAPL, 1.1, 1.2
 114 _
 115 MT-Level
 116 .TE
 117
 118 .SH SEE ALSO
 119 .sp
 120 .LP
 121 \fBdat_ia_open\fR(3DAT), \fBlibdat\fR(3LIB), \fBattributes\fR(5)