xref: /illumos-gate/usr/src/man/man9f/net_getmtu.9f (revision bbf21555)
te
Copyright (C) 2008, Sun Microsystems, Inc. All Rights Reserved.
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.
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.
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]
NET_GETMTU 9F "May 1, 2008"
NAME
net_getmtu - determine the MTU of a given network interface
SYNOPSIS
#include <sys/neti.h>

int net_getmtu(const net_data_t net, const phy_if_t ifp);
INTERFACE LEVEL
illumos DDI specific (illumos DDI).
PARAMETERS
net

value returned from a successful call to net_protocol_lookup(9F).

ifp

value returned from a successful call to net_phylookup(9F) or net_phygetnext(9F).

DESCRIPTION
The net_getmtu() function receives information about the current MTU of a network interface. The value returned from this function call should not be cached as the MTU of a network interface since it is not guaranteed to be constant.
RETURN VALUES
The net_getmtu() function returns -1 if the network protocol does not support this feature and otherwise returns the current MTU of the network interface.
CONTEXT
The net_getmtu() function may be called from user, kernel, or interrupt context.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Committed
SEE ALSO
net_phygetnext (9F), net_phylookup (9F), net_protocol_lookup (9F)