Blame libipq/ipq_create_handle.3

Packit Service d1fe03
.TH IPQ_CREATE_HANDLE 3 "16 October 2001" "Linux iptables 1.2" "Linux Programmer's Manual" 
Packit Service d1fe03
.\"
Packit Service d1fe03
.\"     Copyright (c) 2000-2001 Netfilter Core Team
Packit Service d1fe03
.\"
Packit Service d1fe03
.\"     This program is free software; you can redistribute it and/or modify
Packit Service d1fe03
.\"     it under the terms of the GNU General Public License as published by
Packit Service d1fe03
.\"     the Free Software Foundation; either version 2 of the License, or
Packit Service d1fe03
.\"     (at your option) any later version.
Packit Service d1fe03
.\"
Packit Service d1fe03
.\"     This program is distributed in the hope that it will be useful,
Packit Service d1fe03
.\"     but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit Service d1fe03
.\"     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Packit Service d1fe03
.\"     GNU General Public License for more details.
Packit Service d1fe03
.\"
Packit Service d1fe03
.\"     You should have received a copy of the GNU General Public License
Packit Service d1fe03
.\"     along with this program; if not, write to the Free Software
Packit Service d1fe03
.\"     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
Packit Service d1fe03
.\"
Packit Service d1fe03
.\"
Packit Service d1fe03
.SH NAME
Packit Service d1fe03
ipq_create_handle, ipq_destroy_handle \(em create and destroy libipq handles.
Packit Service d1fe03
.SH SYNOPSIS
Packit Service d1fe03
.B #include <linux/netfilter.h>
Packit Service d1fe03
.br
Packit Service d1fe03
.B #include <libipq.h>
Packit Service d1fe03
.sp
Packit Service d1fe03
.BI "struct ipq_handle *ipq_create_handle(u_int32_t " flags ", u_int32_t " protocol ");"
Packit Service d1fe03
.br
Packit Service d1fe03
.BI "int ipq_destroy_handle(struct ipq_handle *" h );
Packit Service d1fe03
.SH DESCRIPTION
Packit Service d1fe03
The
Packit Service d1fe03
.B ipq_create_handle
Packit Service d1fe03
function initialises libipq for an application, attempts to bind to the
Packit Service d1fe03
Netlink socket used by ip_queue, and returns an opaque context handle.  It
Packit Service d1fe03
should be the first libipq function to be called by an application.  The
Packit Service d1fe03
handle returned should be used in all subsequent library calls which 
Packit Service d1fe03
require a handle parameter.
Packit Service d1fe03
.PP
Packit Service d1fe03
The
Packit Service d1fe03
.I flags
Packit Service d1fe03
parameter is not currently used and should be set to zero by the application
Packit Service d1fe03
for forward compatibility.
Packit Service d1fe03
.PP
Packit Service d1fe03
The
Packit Service d1fe03
.I protocol
Packit Service d1fe03
parameter is used to specify the protocol of the packets to be queued.
Packit Service d1fe03
Valid values are NFPROTO_IPV4 for IPv4 and NFPROTO_IPV6 for IPv6. Currently,
Packit Service d1fe03
only one protocol may be queued at a time for a handle.
Packit Service d1fe03
.PP
Packit Service d1fe03
The
Packit Service d1fe03
.B ipq_destroy_handle
Packit Service d1fe03
function frees up resources allocated by
Packit Service d1fe03
.BR ipq_create_handle ,
Packit Service d1fe03
and should be used when the handle is no longer required by the application.
Packit Service d1fe03
.SH RETURN VALUES
Packit Service d1fe03
On success,
Packit Service d1fe03
.B ipq_create_handle
Packit Service d1fe03
returns a pointer to a context handle.
Packit Service d1fe03
.br
Packit Service d1fe03
On failure, NULL is returned.
Packit Service d1fe03
.PP
Packit Service d1fe03
On success,
Packit Service d1fe03
.B ipq_destroy_handle
Packit Service d1fe03
returns zero.
Packit Service d1fe03
.br
Packit Service d1fe03
On failure, \-1 is returned.
Packit Service d1fe03
.SH ERRORS
Packit Service d1fe03
On failure, a descriptive error message will be available
Packit Service d1fe03
via the
Packit Service d1fe03
.B ipq_errstr
Packit Service d1fe03
function.
Packit Service d1fe03
.SH BUGS
Packit Service d1fe03
None known.
Packit Service d1fe03
.SH AUTHOR
Packit Service d1fe03
James Morris <jmorris@intercode.com.au>
Packit Service d1fe03
.SH COPYRIGHT
Packit Service d1fe03
Copyright (c) 2000-2001 Netfilter Core Team.
Packit Service d1fe03
.PP
Packit Service d1fe03
Distributed under the GNU General Public License.
Packit Service d1fe03
.SH SEE ALSO
Packit Service d1fe03
.BR iptables (8),
Packit Service d1fe03
.BR libipq (3).