Next Previous

Retired Document

Important: This sample code may not represent best practices for current development. The project may use deprecated symbols and illustrate technologies and techniques that are no longer recommended.

Relevant replacement documents include:

http://developer.apple.com/library/mac/#documentation/Networking/Conceptual/SystemConfigFrameworks/SC_Intro/SC_Intro.html%23//apple_ref/doc/uid/TP40001065

MoreSCF/MoreSCFPortScanner.h

/*

    File:       MoreSCFPortScanner.h

    Contains:   Code to generate list of network ports on Mac OS X.

    Written by: DTS, based on code by Network preferences engineering

    Copyright:  Copyright (c) 2007 by Apple Inc., All Rights Reserved.

    Disclaimer: IMPORTANT:  This Apple software is supplied to you by Apple Inc.

                ("Apple") in consideration of your agreement to the following terms, and your

                use, installation, modification or redistribution of this Apple software

                constitutes acceptance of these terms.  If you do not agree with these terms,

                please do not use, install, modify or redistribute this Apple software.

                In consideration of your agreement to abide by the following terms, and subject

                to these terms, Apple grants you a personal, non-exclusive license, under Apple's

                copyrights in this original Apple software (the "Apple Software"), to use,

                reproduce, modify and redistribute the Apple Software, with or without

                modifications, in source and/or binary forms; provided that if you redistribute

                the Apple Software in its entirety and without modifications, you must retain

                this notice and the following text and disclaimers in all such redistributions of

                the Apple Software.  Neither the name, trademarks, service marks or logos of

                Apple Inc. may be used to endorse or promote products derived from the

                Apple Software without specific prior written permission from Apple.  Except as

                expressly stated in this notice, no other rights or licenses, express or implied,

                are granted by Apple herein, including but not limited to any patent rights that

                may be infringed by your derivative works or by other works in which the Apple

                Software may be incorporated.

                The Apple Software is provided by Apple on an "AS IS" basis.  APPLE MAKES NO

                WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED

                WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR

                PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND OPERATION ALONE OR IN

                COMBINATION WITH YOUR PRODUCTS.

                IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR

                CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE

                GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

                ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION AND/OR DISTRIBUTION

                OF THE APPLE SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER THEORY OF CONTRACT, TORT

                (INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN

                ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

    Change History (most recent first):

$Log: MoreSCFPortScanner.h,v $

Revision 1.12  2006/11/24 12:40:49  eskimo1

Document the old vs new implementation.  Add user-visible name keys for FireWire and Bluetooth on the old implementation.

Revision 1.11  2006/03/27 14:42:42  eskimo1

Eliminate high-bit set characters.

Revision 1.10  2006/03/24 16:15:35  eskimo1

Tidy headers: eliminate #pragma once, check C++ guards, eliminate bogus pragmas.

Revision 1.9  2006/03/24 15:44:46  eskimo1

Updated copyright.

Revision 1.8  2006/03/24 12:38:54  eskimo1

Eliminate "pascal" keyword.

Revision 1.7  2006/03/24 11:30:20  eskimo1

Eliminated "MoreSetup.h" to make it easier for folks to copy MIB source into their projects.

Revision 1.6  2003/10/25 02:15:00  eskimo1

Get file name right in header comment.

Revision 1.5  2003/02/26 20:59:18  eskimo1

<rdar://problem/3183087> Added support for V.92 modem hold.

Revision 1.4  2002/11/09 00:01:09  eskimo1

Added compile time environment check. When using framework includes, explicitly include the frameworks we need. Convert nil to NULL.

Revision 1.3  2002/01/31 10:20:37  eskimo1

Added bug numbers for the bugs requesting port scanner APIs.

Revision 1.2  2002/01/22 06:17:22  eskimo1

Total rewrite. Kept Robert's ideas but complete rewrote the implementation and also changed the API to work better in an SCF environment.

Revision 1.1  2002/01/16 22:52:39  eskimo1

First checked in.

*/

#ifndef _MORESCFPORTSCANNER_H

#define _MORESCFPORTSCANNER_H

/////////////////////////////////////////////////////////////////

// System Interfaces

#include <IOKit/IOKitLib.h>

#include <CoreServices/CoreServices.h>

/////////////////////////////////////////////////////////////////

#ifdef __cplusplus

extern "C" {

#endif

/////////////////////////////////////////////////////////////////

// Port Scanner

// IMPORTANT

// In Mac OS X 10.4 Apple introduced a new API, SCNetworkInterfaceCopyAll, which returns

// a list of networking ports and their user-visible names.  If that API is available,

// you should use it.  MoreSCCreatePortArray will use this API automatically if it's

// present.

//

// If MoreSCCreatePortArray uses the new API, your port name callback (as installed by

// MoreSCFSetPortNameCallback) will not be called (because the system takes care of

// the getting the port's user visible name).  Thus, if you require 10.4 or later,

// you don't need to install this callback.

extern OSStatus MoreSCCreatePortArray(CFArrayRef *portArray);

    // Builds a list of network ports and returns their attributes as a CFArray

    // of CFDictionaries, with one dictionary per port.  The array is sorted in

    // the default order which one would display the ports to the user (and set

    // them up in the IPv4 service order array). Each entries contains the

    // following required keys.

//

    // o kSCPropUserDefinedName -- the user-visible name of the port

//

    // o kSCPropNetInterfaceHardware -- the hardware type of the interface,

    //   typically kSCEntNetEthernet, kSCEntNetAirPort, kSCEntNetFireWire,

    //   or kSCEntNetModem

//

    // o kSCPropNetInterfaceType -- either kSCValNetInterfaceTypeEthernet

    //   or kSCValNetInterfaceTypePPP

//

    // o kSCPropNetInterfaceDeviceName -- typically the BSD name of the

    //   network device; for serial-like devices this is the base

    //   name, including the suffix, but not including any leading "cu."

    //   and so on

//

    // The dictionary may also contain values for the following keys.

//

    // o kSCPropNetInterfaceSubType -- either kSCValNetInterfaceSubTypePPPSerial

    //   or kSCValNetInterfaceSubTypePPPoE, only present if

    //   kSCPropNetInterfaceType is kSCValNetInterfaceTypePPP

//

    // o kSCPropMACAddress -- the MAC address for Ethernet-like devices,

    //   encoded as a colon delimited string

//

    // o kMoreSCPropNetInterfaceHardwareVariant -- set to

    //   kMoreSCValNetInterfaceHardwareVariantIrDACOMM or kMoreSCValNetInterfaceHardwareVariantBluetooth

    //   to distinguish modem/serial ports from IrDA COMM or Bluetooth serial ports

//

    // o kSCPropNetInterfaceSupportsModemOnHold -- may be present for

    //   modem devices (kSCPropNetInterfaceHardware is kSCEntNetModem); if

    //   present, this is a CFNumber of value 0 or 1 indicating whether the

    //   modem supports V.92 call waiting; if not present, assume 0

//

    // The dictionary may also contain other keys. These keys were set up

    // during the operation of the function. You may find their values useful.

//

    // o "AAPL,slot-name" -- For PCI devices this is the name of the

    //   slot that the device is plugged in to.

//

    // o "IOChildIndex" -- For PCI devices thish is the port number.

    //   To tell you the truth I'm not exactly sure what this means )-:

//

    // o kIOBSDNameKey -- For generic Ethernet-like devices this is the

    //   BSD name of the underlying device.

//

    // o kIOTTYBaseNameKey -- For generic serial ports this is the

    //   base name of the serial driver.

//

    // When running on pre-10.4 systems, this function takes a guess at the

    // user-visible name of the port and then calls your callback function (which you

    // install using MoreSCFSetPortNameCallback) to refine that name.  If your

    // callback function doesn't override the user-visible name

    // this function will just returns its guess.  Note that the code

    // that generates the guess is bug-for-bug compatible with the

    // Network preferences panel in Mac OS X 10.1.x and may not produce

    // ideal results. Moreover, the guess is not localised.  Fortunately, this

    // code isn't used on modern systems.

//

    //  portArray must not be NULL.

    // *portArray must be NULL.

    // On success, *portArray will be non-NULL; the caller is responsible for

    // releasing it.

    // On error, *portArray will be NULL.

#define kMoreSCPropNetInterfaceHardwareVariant CFSTR("HardwareVariant")

#define kMoreSCValNetInterfaceHardwareVariantIrDACOMM  CFSTR("IrDA-IrCOMM")

#define kMoreSCValNetInterfaceHardwareVariantBluetooth CFSTR("Bluetooth")

/////////////////////////////////////////////////////////////////

// Localisable Port Names

// You can install a MoreSCFPortNameCallback to return the localised

// name for a port.  The function is called with a non-localised

// port label and is expected to return a localised name.

//

// If you don't install a callback the default (English) names for

// the ports are used.

typedef kern_return_t (*MoreSCFPortNameCallback)(io_object_t interface,

                                                        CFMutableDictionaryRef interfaceInfo,

                                                        CFStringRef proposedUserVisibleName,

                                                        CFStringRef *userVisibleName);

    // MoreSCF calls this callback when it needs to determine the user-visible

    // name of a port.  The callback is provided with a reference to the

    // I/O Registry object, a dictionary of information about that object

    // (this is basically the same dictionary as is returned by

    // MoreSCCreatePortArray, without the kSCPropUserDefinedName of course)

    // and a proposed user-visible name.  The routine can either leave

    // *userVisibleName as NULL, in which case MoreSCF uses the

    // proposedUserVisible name, or set it to a user-visible name that's

    // better than the proposed one.

//

    // For example, your code might have a set of localised strings

    // for each of the port labels listed below, and return the

    // appropriate string based on the current user's preferences.  Or

    // your code might have special information about a specific

    // interface, and return a custom string for that interface.

//

    // MoreSCF does keyword substitution (for example, replacing

    // %2$@ with the PCI slot name that the device resides in) *after*

    // calling this routine, so you don't have to parse these variable

    // keywords out of proposedUserVisibleName when deciding on your

    // localisations.  You can also modify the substitions that are

    // performed by returning a string with different keywords.

//

    // interface will not be 0.

    // interfaceInfo will not be NULL.

    // proposedUserVisibleName will not be NULL.  It will be either one of the

    // labels listed below, or a more specific name derived from the I/O Registry.

    // userVisibleName will not be NULL.

    // *userVisibleName will be NULL.

    // On success, *userVisibleName may be NULL or not NULL.  If not NULL,

    // it's the user visible name of the port.  If NULL, your code doesn't

    // have a user visible name for this type of port.

    // On error, *userVisibleName must be NULL.

//

    // *userVisibleName can contain the following strings which are substituted

    // by MoreSCF upon return.

//

    //   %1$@ is the BSD name of the device

    //   %2$@ is the PCI slot name of the device

    //   %3$@ is the function number of a multifunction PCI device

    //   %4$@ is the lowercased TTY base name of the device

    //        Why lowercase?  Because that's what the 10.1.x control

    //        panel does, for reasons unknown.

//

    // IMPORTANT

    // If you require Mac OS X 10.4 or later, you don't need to install

    // this callback.  See the comments at the top of this file for an

    // explanation.

#define kMoreSCPortLabelEthernetBuiltIn         CFSTR("Built-in Ethernet")

    // built-in Ethernet

#define kMoreSCPortLabelFireWireBuiltIn         CFSTR("Built-in FireWire")

    // built-in FireWire

#define kMoreSCPortLabelAirPort                 CFSTR("AirPort")

    // Apple AirPort

#define kMoreSCPortLabelWireless                CFSTR("Wireless Network Adaptor")

    // non-AirPort wireless

#define kMoreSCPortLabelEthernetPCI             CFSTR("PCI Ethernet Slot %2$@")

    // generic PCI card

#define kMoreSCPortLabelEthernetPCIMultiport    CFSTR("PCI Ethernet Slot %2$@, Port %3$@")

    // multiport PCI card (I think we handle this wrongly but it's compatible

    // with the Network preferences panel)

#define kMoreSCPortLabelEthernet                CFSTR("Ethernet Adaptor (%1$@)")

    // non-PCI Ethernet

#define kMoreSCPortLabelModemInternal           CFSTR("Internal Modem")

    // built-in modem

#define kMoreSCPortLabelModemPort               CFSTR("Modem Port")

    // built-in serial port (eg Beige G3)

#define kMoreSCPortLabelPrinterPort             CFSTR("Printer Port")

    // ditto

#define kMoreSCPortLabelModemPrinterPort        CFSTR("Modem/Printer Port")

    // built-in serial port (eg Wallstreet)

#define kMoreSCPortLabelModemUSB                CFSTR("USB Modem")

    // generic USB modem, usually we find a better name in I/O registry

#define kMoreSCPortLabelModemIrDA               CFSTR("IrDA Modem Port")

    // USB-based IrDA, including built-in port on TiBook

#define kMoreSCPortLabelModemBluetooth          CFSTR("Bluetooth")

    // Bluetooth modem

#define kMoreSCPortLabelSerial                  CFSTR("%4$@-port")

    // generic serial port

extern void MoreSCFSetPortNameCallback(MoreSCFPortNameCallback callback);

    // Installs the callback function, eliminating any existing one.

    // Pass NULL to remove your callback.

//

    // IMPORTANT

    // If you require Mac OS X 10.4 or later, you don't need to install

    // this callback.  See the comments at the top of this file for an

    // explanation.

/////////////////////////////////////////////////////////////////

#ifdef __cplusplus

#endif

#endif

Next Previous