share/man/man3dlpi/dlpi_send.3dlpi

   1 '\" te
   2 .\"  Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH DLPI_SEND 3DLPI "Jul 15, 2008"
   7 .SH NAME
   8 dlpi_send \- send a data message using DLPI
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-ldlpi\fR [ \fIlibrary\fR... ]
  13 #include <libdlpi.h>
  14
  15 \fBint\fR \fBdlpi_send\fR(\fBdlpi_handle_t\fR \fIdh\fR, \fBconst void *\fR\fIdaddrp\fR,
  16      \fBsize_t\fR \fIdaddrlen\fR, \fBconst void *\fR\fImsgbuf\fR, \fBsize_t\fR \fImsglen\fR,
  17      \fBconst dlpi_sendinfo_t *\fR\fIsendp\fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 The \fBdlpi_send()\fR function attempts to send the contents of \fImsgbuf\fR
  24 over the \fBDLPI\fR link instance associated with the \fBDLPI\fR handle
  25 \fIdh\fR to the destination address specified by \fIdaddrp\fR. The size of
  26 \fImsgbuf\fR and  \fIdaddrp\fR are provided by the \fImsglen\fR and
  27 \fIdaddrlen\fR arguments, respectively. The attempt will fail if \fIdh\fR is
  28 not in the \fBDL_IDLE\fR \fBDLPI\fR state, the address named by \fIdaddrp\fR is
  29 invalid, \fIdaddrlen\fR is larger than \fBDLPI_PHYSADDR_MAX\fR, or \fImsglen\fR
  30 is outside the range reported by \fBdlpi_info\fR(3DLPI).
  31 .sp
  32 .LP
  33 If the \fBsendp\fR argument is \fINULL\fR, data is sent using the bound SAP
  34 associated with \fIdh\fR (see \fBdlpi_bind\fR(3DLPI)) and with default
  35 priority.  Otherwise, \fIsendp\fR must point to a \fBdlpi_sendinfo_t\fR
  36 structure defined in \fB<libdlpi.h>\fR as follows:
  37 .sp
  38 .in +2
  39 .nf
  40 typedef struct {
  41         uint_t          dsi_sap;
  42         dl_priority_t   dsi_prio;
  43 } dlpi_sendinfo_t;
  44 .fi
  45 .in -2
  46
  47 .sp
  48 .LP
  49 The \fIdsi_sap\fR value indicates the SAP to use for the message and the
  50 \fIdsi_prio\fR argument indicates the priority.  The priority range spans from
  51 0 to 100, with 0 being the highest priority.  If one wishes to only alter the
  52 SAP or priority (but not both), the current SAP can be retrieved using
  53 \fBdlpi_info\fR(3DLPI), and the default priority can be specified by using the
  54 \fBDL_QOS_DONT_CARE\fR constant.
  55 .sp
  56 .LP
  57 If the handle is in raw mode (see \fBDLPI_RAW\fR in \fBdlpi_open\fR(3DLPI)),
  58 \fImsgbuf\fR must start with the link-layer header (see \fBdlpi\fR(7P)). In raw
  59 mode, the contents of \fIdaddrp\fR and \fIsendp\fR are ignored, as they are
  60 already specified by the link-layer header in \fImsgbuf\fR.
  61 .sp
  62 .LP
  63 If \fImsgbuf\fR is accepted for delivery, no error is returned. However,
  64 because only unacknowledged connectionless service (\fBDL_CLDLS\fR) is
  65 currently supported, a successful return does not guarantee that the data will
  66 be successfully delivered to \fIdaddrp\fR.
  67 .SH RETURN VALUES
  68 .sp
  69 .LP
  70 Upon success, \fBDLPI_SUCCESS\fR is returned. If \fBDL_SYSERR\fR is returned,
  71 \fBerrno\fR contains the specific UNIX system error value. Otherwise, a
  72 \fBDLPI\fR error value defined in \fB<sys/dlpi.h>\fR or an error value listed
  73 in the following section is returned.
  74 .SH ERRORS
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fBDLPI_EINHANDLE\fR\fR
  79 .ad
  80 .RS 18n
  81 Invalid \fBDLPI\fR handle
  82 .RE
  83
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fBDLPI_EINVAL\fR\fR
  88 .ad
  89 .RS 18n
  90 Invalid argument
  91 .RE
  92
  93 .SH ATTRIBUTES
  94 .sp
  95 .LP
  96 See \fBattributes\fR(5) for description of the following attributes:
  97 .sp
  98
  99 .sp
 100 .TS
 101 box;
 102 c | c
 103 l | l .
 104 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 105 _
 106 Interface Stability     Committed
 107 _
 108 MT-Level        Safe
 109 .TE
 110
 111 .SH SEE ALSO
 112 .sp
 113 .LP
 114 \fBdlpi_bind\fR(3DLPI), \fBdlpi_info\fR(3DLPI), \fBdlpi_open\fR(3DLPI),
 115 \fBlibdlpi\fR(3LIB), \fBattributes\fR(5), \fBdlpi\fR(7P)