cjdns/interface/tuntap/TUNInterface.h

/* vim: set expandtab ts=4 sw=4: */
/*
 * You may redistribute this program and/or modify it under the terms of
 * the GNU General Public License as published by the Free Software Foundation,
 * either version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
#ifndef TUNInterface_H
#define TUNInterface_H

#include "util/events/EventBase.h"
#include "util/log/Log.h"
#include "exception/Except.h"
#include "memory/Allocator.h"
#include "interface/Interface.h"

/**
 * This is the maximum size that will be accepted as an interface name.
 * If this runs on a system where IFNAMSIZ is less then this, names larger
 * than that will also be rejected.
 */
#ifdef Windows
    #define TUNInterface_IFNAMSIZ 256
#else
    #define TUNInterface_IFNAMSIZ 16
#endif

/**
 * Create a new TUNInterface.
 *
 * @param interfaceName the interface name you *want* to use or NULL to let the kernel decide.
 * @param assignedInterfaceName an empty buffer which will be filled in with the interface
 *                              name that is assigned.
 * @param base the libevent event base to use for listening for incoming packet events.
 * @param logger for logging messages about the tun device.
 * @param eh if this function fails, it will raise one of the following.
 *           TUNInterface_new_BAD_TUNNEL interfaceName was an invalid tun device name.
 *           TUNInterface_new_INTERNAL Something went wrong internally.
 *           TUNInterface_new_PERMISSION The user running this process doesn't have
 *                                       permission to open a tun device.
 * @param allocator a means of getting memory.
 * @return a Interface.
 */
#define TUNInterface_new_INTERNAL -3
#define TUNInterface_new_BAD_TUNNEL -2
#define TUNInterface_new_PERMISSION -1
struct Interface* TUNInterface_new(const char* interfaceName,
                                   char assignedInterfaceName[TUNInterface_IFNAMSIZ],
                                   struct EventBase* base,
                                   struct Log* logger,
                                   struct Except* eh,
                                   struct Allocator* alloc);
#endif