From 460c7477af95cf18b66bbdab5882cd5b3b367731 Mon Sep 17 00:00:00 2001 From: James Morris Date: Tue, 16 Oct 2001 14:41:02 +0000 Subject: Updated libipq documentation with information on new timeout feature, as well as minor miscellaneous updates. Added a bit more info to the install-devel description in the INSTALL file. --- INSTALL | 3 ++- libipq/ipq_create_handle.3 | 8 ++++---- libipq/ipq_errstr.3 | 6 +++--- libipq/ipq_message_type.3 | 8 ++++---- libipq/ipq_read.3 | 41 ++++++++++++++++++++++++++--------------- libipq/ipq_set_mode.3 | 8 ++++---- libipq/ipq_set_verdict.3 | 8 ++++---- libipq/libipq.3 | 16 +++++++++------- 8 files changed, 56 insertions(+), 42 deletions(-) diff --git a/INSTALL b/INSTALL index 4539232e..62b4f175 100644 --- a/INSTALL +++ b/INSTALL @@ -13,7 +13,8 @@ FOLLOW THESE STEPS: 2) Finally, you need to to install the shared libraries, and the binary: # make install KERNEL_DIR=<> -If you are a developer, you can install the header files, like: +If you are a developer, you can install the headers, development libraries +and associated development man pages, with: # make install-devel That's it! diff --git a/libipq/ipq_create_handle.3 b/libipq/ipq_create_handle.3 index 5c981371..da99e549 100644 --- a/libipq/ipq_create_handle.3 +++ b/libipq/ipq_create_handle.3 @@ -1,8 +1,8 @@ -.TH IPQ_CREATE_HANDLE 3 "18 November 2000" "Linux iptables 1.1.3+" "Linux Programmer's Manual" +.TH IPQ_CREATE_HANDLE 3 "16 October 2001" "Linux iptables 1.2" "Linux Programmer's Manual" .\" -\" $Id: $ +\" $Id: ipq_create_handle.3,v 1.1 2000/11/20 14:13:31 jamesm Exp $ .\" -.\" Copyright (c) 2000 Netfilter Core Team +.\" 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 @@ -70,7 +70,7 @@ None known. .SH AUTHOR James Morris .SH COPYRIGHT -Copyright (c) 2000 Netfilter Core Team. +Copyright (c) 2000-2001 Netfilter Core Team. .PP Distributed under the GNU General Public License. .SH SEE ALSO diff --git a/libipq/ipq_errstr.3 b/libipq/ipq_errstr.3 index ec43ff6b..96614694 100644 --- a/libipq/ipq_errstr.3 +++ b/libipq/ipq_errstr.3 @@ -1,6 +1,6 @@ -.TH IPQ_ERRSTR 3 "18 November 2000" "Linux iptables 1.1.3+" "Linux Programmer's Manual" +.TH IPQ_ERRSTR 3 "16 October 2001" "Linux iptables 1.2" "Linux Programmer's Manual" .\" -.\" $Id: $ +.\" $Id: ipq_errstr.3,v 1.1 2000/11/20 14:13:32 jamesm Exp $ .\" .\" Copyright (c) 2000 Netfilter Core Team .\" @@ -58,7 +58,7 @@ None known. .SH AUTHOR James Morris .SH COPYRIGHT -Copyright (c) 2000 Netfilter Core Team. +Copyright (c) 2000-2001 Netfilter Core Team. .PP Distributed under the GNU General Public License. .SH SEE ALSO diff --git a/libipq/ipq_message_type.3 b/libipq/ipq_message_type.3 index 4a2de1dc..0594518f 100644 --- a/libipq/ipq_message_type.3 +++ b/libipq/ipq_message_type.3 @@ -1,8 +1,8 @@ -.TH IPQ_MESSAGE_TYPE 3 "18 November 2000" "Linux iptables 1.1.3+" "Linux Programmer's Manual" +.TH IPQ_MESSAGE_TYPE 3 "16 October 2001" "Linux iptables 1.2" "Linux Programmer's Manual" .\" -.\" $Id: $ +.\" $Id: ipq_message_type.3,v 1.1 2000/11/20 14:13:32 jamesm Exp $ .\" -.\" Copyright (c) 2000 Netfilter Core Team +.\" 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 @@ -128,7 +128,7 @@ None known. .SH AUTHOR James Morris .SH COPYRIGHT -Copyright (c) 2000 Netfilter Core Team. +Copyright (c) 2000-2001 Netfilter Core Team. .PP Distributed under the GNU General Public License. .SH SEE ALSO diff --git a/libipq/ipq_read.3 b/libipq/ipq_read.3 index 62763ca4..14867dda 100644 --- a/libipq/ipq_read.3 +++ b/libipq/ipq_read.3 @@ -1,8 +1,8 @@ -.TH IPQ_READ 3 "18 November 2000" "Linux iptables 1.1.3+" "Linux Programmer's Manual" +.TH IPQ_READ 3 "16 October 2001" "Linux iptables 1.2" "Linux Programmer's Manual" .\" -.\" $Id: $ +.\" $Id: ipq_read.3,v 1.1 2000/11/20 14:13:32 jamesm Exp $ .\" -.\" Copyright (c) 2000 Netfilter Core Team +.\" 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 @@ -20,7 +20,7 @@ .\" .\" .SH NAME -ipq_read - wait for queue messages from ip_queue and read into supplied buffer +ipq_read - read queue messages from ip_queue and read into supplied buffer .SH SYNOPSIS .B #include .br @@ -30,17 +30,17 @@ ipq_read - wait for queue messages from ip_queue and read into supplied buffer .SH DESCRIPTION The .B ipq_read -function waits for a queue message to arrive from the kernel and copies it to +function reads a queue message from the kernel and copies it to the memory pointed to by .I buf to a maximum length of -. I len . +. IR len . .PP The .I h parameter is a context handle which must previously have been returned successfully from a call to -.B ipq_create_handle . +.BR ipq_create_handle . .PP The caller is responsible for ensuring that the memory pointed to by .I buf @@ -50,7 +50,11 @@ bytes. .PP The .I timeout -parameter is not currently implemented. +parameter may be used to set a timeout for the operation, specified in microseconds. +This is implemented internally by the library via the +.BR select +system call. A value of zero provides normal, backwards-compatible blocking behaviour +with no timeout. A negative value causes the function to return immediately. .PP Data returned via .I buf @@ -62,7 +66,15 @@ functions to access the queue message in the buffer. .SH RETURN VALUE On failure, -1 is returned. .br -On success, a non-zero positive value is returned. +On success, a non-zero positive value is returned when no timeout +value is specified. +.br +On success with a timeout value specified, zero is returned if no data +was available to read, or if a non-blocked signal was caught. In the +latter case, the global +.B errno +value will be set to +.BR EINTR . .SH ERRORS On error, a descriptive error message will be available via the @@ -77,19 +89,18 @@ may itself be an error message from a higher level kernel component. Use to determine if it is an error message, and .B ipq_get_msgerr to access the value of the message. -.SH TODO -Implement -.I timeout -as part of a non-blocking interface. .SH BUGS None known. .SH AUTHOR James Morris .SH COPYRIGHT -Copyright (c) 2000 Netfilter Core Team. +Copyright (c) 2000-2001 Netfilter Core Team. .PP Distributed under the GNU General Public License. +.SH CREDITS +Joost Remij implemented the timeout feature, which appeared in the 1.2.4 release of iptables. .SH SEE ALSO .BR iptables (8), -.BR libipq (3). +.BR libipq (3), +.BR select (2). diff --git a/libipq/ipq_set_mode.3 b/libipq/ipq_set_mode.3 index ad1d0e95..241581eb 100644 --- a/libipq/ipq_set_mode.3 +++ b/libipq/ipq_set_mode.3 @@ -1,8 +1,8 @@ -.TH IPQ_SET_MODE 3 "18 November 2000" "Linux iptables 1.1.3+" "Linux Programmer's Manual" +.TH IPQ_SET_MODE 3 "16 October 2001" "Linux iptables 1.2" "Linux Programmer's Manual" .\" -.\" $Id: $ +.\" $Id: ipq_set_mode.3,v 1.1 2000/11/20 14:13:32 jamesm Exp $ .\" -.\" Copyright (c) 2000 Netfilter Core Team +.\" 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 @@ -99,7 +99,7 @@ None known. .SH AUTHOR James Morris .SH COPYRIGHT -Copyright (c) 2000 Netfilter Core Team. +Copyright (c) 2000-2001 Netfilter Core Team. .PP Distributed under the GNU General Public License. .SH SEE ALSO diff --git a/libipq/ipq_set_verdict.3 b/libipq/ipq_set_verdict.3 index de4ccdbf..84a94119 100644 --- a/libipq/ipq_set_verdict.3 +++ b/libipq/ipq_set_verdict.3 @@ -1,8 +1,8 @@ -.TH IPQ_SET_VERDICT 3 "18 November 2000" "Linux iptables 1.1.3+" "Linux Programmer's Manual" +.TH IPQ_SET_VERDICT 3 "16 October 2001" "Linux iptables 1.2" "Linux Programmer's Manual" .\" -.\" $Id: $ +.\" $Id: ipq_set_verdict.3,v 1.1 2000/11/20 14:13:32 jamesm Exp $ .\" -.\" Copyright (c) 2000 Netfilter Core Team +.\" 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 @@ -86,7 +86,7 @@ None known. .SH AUTHOR James Morris .SH COPYRIGHT -Copyright (c) 2000 Netfilter Core Team. +Copyright (c) 2000-2001 Netfilter Core Team. .PP Distributed under the GNU General Public License. .SH SEE ALSO diff --git a/libipq/libipq.3 b/libipq/libipq.3 index 1d2e498c..54898bf6 100644 --- a/libipq/libipq.3 +++ b/libipq/libipq.3 @@ -1,8 +1,8 @@ -.TH LIBIPQ 3 "18 November 2000" "Linux iptables 1.1.3+" "Linux Programmer's Manual" +.TH LIBIPQ 3 "16 October 2001" "Linux iptables 1.2" "Linux Programmer's Manual" .\" -.\" $Id: libipq.3,v 1.1 2000/11/20 14:13:32 jamesm Exp $ +.\" $Id: libipq.3,v 1.2 2001/05/26 20:32:01 laforge Exp $ .\" -.\" Copyright (c) 2000 Netfilter Core Team +.\" 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 @@ -242,8 +242,6 @@ Processes require CAP_NET_ADMIN capabilty to access the kernel ip_queue module. Such processes can potentially access and modify any IP packets received, generated or forwarded by the kernel. .SH TODO -Implement a non-blocking interface. -.br Per-handle .B ipq_errno values. @@ -252,9 +250,13 @@ Probably. .SH AUTHOR James Morris .SH COPYRIGHT -Copyright (c) 2000 Netfilter Core Team. +Copyright (c) 2000-2001 Netfilter Core Team. .PP Distributed under the GNU General Public License. +.SH CREDITS +Joost Remij implemented the +.B ipq_read +timeout feature, which appeared in the 1.2.4 release of iptables. .SH SEE ALSO .BR iptables (8), .BR ipq_create_handle (3), @@ -268,7 +270,7 @@ Distributed under the GNU General Public License. .BR ipq_set_mode (3), .BR ipq_set_verdict (3). .PP -The Netfilter home page at http://netfilter.gnumonks.org/ +The Netfilter home page at http://netfilter.samba.org/ which has links to The Networking Concepts HOWTO, The Linux 2.4 Packet Filtering HOWTO, The Linux 2.4 NAT HOWTO, The Netfilter Hacking HOWTO, The Netfilter FAQ and many other useful resources. -- cgit v1.2.3