share/man/man9f/net_getmtu.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_GETMTU 9F "May 1, 2008"
   7 .SH NAME
   8 net_getmtu \- determine the MTU of a given network interface
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/neti.h>
  13
  14 \fBint\fR \fBnet_getmtu\fR(\fBconst\fR \fBnet_data_t\fR \fInet\fR, \fBconst\fR \fBphy_if_t\fR \fIifp\fR);
  15 .fi
  16
  17 .SH INTERFACE LEVEL
  18 .sp
  19 .LP
  20 Solaris DDI specific (Solaris DDI).
  21 .SH PARAMETERS
  22 .sp
  23 .ne 2
  24 .na
  25 \fB\fInet\fR\fR
  26 .ad
  27 .RS 7n
  28 value returned from a successful call to \fBnet_protocol_lookup\fR(9F).
  29 .RE
  30
  31 .sp
  32 .ne 2
  33 .na
  34 \fB\fIifp\fR\fR
  35 .ad
  36 .RS 7n
  37 value returned from a successful call to \fBnet_phylookup\fR(9F) or
  38 \fBnet_phygetnext\fR(9F).
  39 .RE
  40
  41 .SH DESCRIPTION
  42 .sp
  43 .LP
  44 The \fBnet_getmtu()\fR function receives information about the current
  45 \fBMTU\fR of a network interface. The value returned from this function call
  46 should not be cached as the \fBMTU\fR of a network interface since it is not
  47 guaranteed to be constant.
  48 .SH RETURN VALUES
  49 .sp
  50 .LP
  51 The \fBnet_getmtu()\fR function returns -1 if the network protocol does not
  52 support this feature and otherwise returns the current MTU of the network
  53 interface.
  54 .SH CONTEXT
  55 .sp
  56 .LP
  57 The \fBnet_getmtu()\fR function may be called from user,  kernel, or interrupt
  58 context.
  59 .SH ATTRIBUTES
  60 .sp
  61 .LP
  62 See \fBattributes\fR(5) for descriptions of the following attributes:
  63 .sp
  64
  65 .sp
  66 .TS
  67 box;
  68 c | c
  69 l | l .
  70 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  71 _
  72 Interface Stability     Committed
  73 .TE
  74
  75 .SH SEE ALSO
  76 .sp
  77 .LP
  78 \fBnet_phygetnext\fR(9F), \fBnet_phylookup\fR(9F),
  79 \fBnet_protocol_lookup\fR(9F)