share/man/man9f/net_getpmtuenabled.9f

   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 NET_GETPMTUENABLED 9F "May 1, 2008"
   7 .SH NAME
   8 net_getpmtuenabled \- determine if path MTU discovery is enabled for a network
   9 protocol
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/neti.h>
  14
  15 \fBint\fR \fBnet_getpmtuenabled\fR(\fBconst\fR \fBnet_data_t\fR \fInet\fR);
  16 .fi
  17
  18 .SH INTERFACE LEVEL
  19 .sp
  20 .LP
  21 Solaris DDI specific (Solaris DDI).
  22 .SH PARAMETERS
  23 .sp
  24 .ne 2
  25 .na
  26 \fB\fInet\fR\fR
  27 .ad
  28 .RS 7n
  29 value returned from a successful call to \fBnet_protocol_lookup\fR(9F).
  30 .RE
  31
  32 .SH DESCRIPTION
  33 .sp
  34 .LP
  35 The \fBnet_getpmtuenabled()\fR function returns a value to indicate whether or
  36 not path \fBMTU\fR (\fBPMTU\fR) discovery is enabled for this network protocol.
  37 .SH RETURN VALUES
  38 .sp
  39 .LP
  40 The \fBnet_getpmtuenabled()\fR function returns:
  41 .sp
  42 .ne 2
  43 .na
  44 \fB-1\fR
  45 .ad
  46 .RS 6n
  47 The network protocol does not support this function.
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB0\fR
  54 .ad
  55 .RS 6n
  56 PATH MTU discovery is disabled.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB1\fR
  63 .ad
  64 .RS 6n
  65 PATH MTU discovery is enabled.
  66 .RE
  67
  68 .SH CONTEXT
  69 .sp
  70 .LP
  71 The \fBnet_getpmtuenabled()\fR function may be called from user,  kernel, or
  72 interrupt context.
  73 .SH ATTRIBUTES
  74 .sp
  75 .LP
  76 See \fBattributes\fR(5) for descriptions of the following attributes:
  77 .sp
  78
  79 .sp
  80 .TS
  81 box;
  82 c | c
  83 l | l .
  84 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  85 _
  86 Interface Stability     Committed
  87 .TE
  88
  89 .SH SEE ALSO
  90 .sp
  91 .LP
  92 \fBnet_getmtu\fR(9F), \fBnet_protocol_lookup\fR(9F)