\" $Id: ipq_create_handle.3,v 1.2 2001/10/16 14:41:02 jamesm Exp $
Copyright (c) 2000-2001 Netfilter Core Team

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 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, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.


ipq_create_handle, ipq_destroy_handle \(em create and destroy libipq handles. #include <linux/netfilter.h>

#include <libipq.h> "struct ipq_handle *ipq_create_handle(u_int32_t " flags ", u_int32_t " protocol ");"

"int ipq_destroy_handle(struct ipq_handle *" h );

The ipq_create_handle function initialises libipq for an application, attempts to bind to the Netlink socket used by ip_queue, and returns an opaque context handle. It should be the first libipq function to be called by an application. The handle returned should be used in all subsequent library calls which require a handle parameter.

The flags parameter is not currently used and should be set to zero by the application for forward compatibility.

The protocol parameter is used to specify the protocol of the packets to be queued. Valid values are NFPROTO_IPV4 for IPv4 and NFPROTO_IPV6 for IPv6. Currently, only one protocol may be queued at a time for a handle.

The ipq_destroy_handle function frees up resources allocated by ipq_create_handle , and should be used when the handle is no longer required by the application.

On success, ipq_create_handle returns a pointer to a context handle.

On failure, NULL is returned.

On success, ipq_destroy_handle returns zero.

On failure, -1 is returned.

On failure, a descriptive error message will be available via the ipq_errstr function. None known. James Morris <jmorris@intercode.com.au> Copyright (c) 2000-2001 Netfilter Core Team.

Distributed under the GNU General Public License.

iptables (8), libipq (3).