Differential D7529 Diff 19347 lib/libifconfig/src/libifconfig_internal.h

Changeset View

Standalone View

lib/libifconfig/src/libifconfig_internal.h

Property	Old Value	New Value
svn:eol-style	null	native \ No newline at end of property
svn:keywords	null	FreeBSD=%H \ No newline at end of property
svn:mime-type	null	text/plain \ No newline at end of property

				/*
				* Copyright (c) 2016, Marie Helene Kvello-Aune
				* All rights reserved.
				*
				* Redistribution and use in source and binary forms, with or without modification,
				* are permitted provided that the following conditions are met:
				*
				* 1. Redistributions of source code must retain the above copyright notice,
				* thislist of conditions and the following disclaimer.
				*
				* 2. Redistributions in binary form must reproduce the above copyright notice,
				* this list of conditions and the following disclaimer in the documentation and/or
				* other materials provided with the distribution.
				*
				* 3. Neither the name of the copyright holder nor the names of its contributors
				* may be used to endorse or promote products derived from this software without
				* specific prior written permission.
				*
				* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
				* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
				* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
				* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
				* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
				* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
				* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
				* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
				* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
				* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
				*/

				#pragma once

				#include "libifconfig.h"


				struct errstate {
				/**
				* Type of error.
				*/
				libifc_errtype errtype;

				/**
				* The error occured in this ioctl() request.
				* Populated if errtype = IOCTL
				*/
				unsigned long ioctl_request;

				/**
				* The value of the global errno variable when the error occured.
				*/
				int errcode;
				};

				struct socketcache {
				int sdindex;
				int sdsize;
				int *sdkeys;
				int *sdvals;
				};

				struct libifc_handle {
				struct errstate error;
				struct socketcache sockets;
				};

				/**
				* Retrieves socket for address family <paramref name="addressfamily"> from
				* cache, or creates it if it doesn't already exist.
				* @param addressfamily The address family of the socket to retrieve
				* @param s The retrieved socket.
				* @return 0 on success, -1 on failure.
				* {@example
				* This example shows how to retrieve a socket from the cache.
				* {@code
				* static void myfunc() \{
				* int s;
				* if (libifc_socket(AF_LOCAL, &s) != 0) \{
				* // Handle error state here
				* \}
				* // user code here
				* \}
				* }
				* }
				*/
				int libifc_socket(libifc_handle_t h, const int addressfamily, int s);

				/** Function used by other wrapper functions to populate _errstate when appropriate.*/
				int libifc_ioctlwrap_ret(libifc_handle_t *h, unsigned long request, int rcode);

				/** Function to wrap ioctl() and automatically populate libifc_errstate when appropriate.*/
				int libifc_ioctlwrap(libifc_handle_t *h, const int addressfamily,
				unsigned long request, struct ifreq *ifr);

				/** <summary> function to wrap ioctl(), casting ifr to caddr_t, and automatically populate libifc_errstate when appropriate.*/
				int libifc_ioctlwrap_caddr(libifc_handle_t *h, const int addressfamily,
				unsigned long request, struct ifreq *ifr);