bsd/net/init.h

   1 /*
   2  * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 /*!
  24         @header init.h
  25         This header defines an API to register a function that will be called when
  26         the network stack is being initialized. This gives a kernel extensions an
  27         opportunity to install filters before sockets are created and network
  28         operations occur.
  29  */
  30 #ifndef _NET_INIT_H_
  31 #define _NET_INIT_H_
  32 #include <sys/kernel_types.h>
  33
  34 /*!
  35         @typedef net_init_func_ptr
  36         @discussion net_init_func_ptr will be called once the networking stack
  37                 initialized and before network operations occur.
  38  */
  39 typedef void    (*net_init_func_ptr)(void);
  40
  41 /*!
  42         @function net_init_add
  43         @discussion Add a function to be called during network initialization. Your
  44                 kext must not unload until the function you  register is called if
  45                 net_init_add returns success.
  46         @param init_func A pointer to a function to be called when the stack is
  47                 initialized.
  48         @result EINVAL - the init_func value was NULL.
  49                         EALREADY - the network has already been initialized
  50                         ENOMEM - there was not enough memory to perform this operation
  51                         0 - success
  52  */
  53 errno_t net_init_add(net_init_func_ptr  init_func);
  54
  55 #ifdef BSD_KERNEL_PRIVATE
  56 /* net_init_run is called from bsd_init */
  57 extern void net_init_run(void);
  58 #endif /* BSD_KERNEL_PRIVATE */
  59
  60 #endif /* _NET_INIT_H_ */