MAN page from Old RedHat 5.X inn-devel-1.7.2-13.i386.rpm

INNDCOMM

Section: C Library Functions (3)
Index

NAME

inndcomm - INND communication part of InterNetNews library

SYNOPSIS

#include "inndcomm.h"intICCopen()intICCclose()voidICCsettimeout(i)    int             i;intICCcommand(cmd, argv, replyp)    char            cmd;    char            *argv[];    char            **replyp;intICCcancel(mesgid)    char            *mesgid;intICCreserve(why)    char            *why;intICCpause(why)    char            *why;intICCgo(why)    char            *why;extern char *ICCfailure;

DESCRIPTION

The routines described in this manual page are part of the InterNetNewslibrary,libinn(3).They are used to send commands to a runninginnd(8)daemon on the local host.The letters ``ICC'' stand forInndControlCommand.

ICCopencreates aUnix-domain datagram socket and binds it to the server's control socket.It returns -1 on failure or zero on success.This routine must be called before any other routine.

ICCclosecloses any descriptors that have been created byICCopen.It returns -1 on failure or zero on success.

ICCsettimeoutcan be called before any of the following routines to determine how longthe library should wait before giving up on getting the server's reply.This is done by setting and catching a SIGALRMsignal(2).If the timeout is less then zero then no reply will be waited for.The SC_SHUTDOWN, SC_XABORT, and SC_XEXEC commands do not get a reply either.The default, which can be obtained by setting the timeout to zero, is towait until the server replies.

ICCcommandsends the commandcmdwith parametersargvto the server.It returns -1 on error.If the server replies, andreplypis not NULL, it will be filled in with an allocated buffer that containsthe full text of the server's reply.This buffer is a string in the form of ``<digits><space><text>''where ``digits'' is the text value of the recommended exit code;zero indicates success.Replies longer then 4000 bytes will be truncated.The possible values ofcmdare defined in the ``inndcomm.h'' header file.The parameters for each command are described inctlinnd(8).This routine returns -1 on communication failure, or the exit statussent by the server which will never be negative.

ICCcancelsends a ``cancel'' message to the server.Mesgidis the Message-ID of the article that should be canceled.The return value is the same as forICCcommand.

ICCpause,ICCreserve,andICCgosend a ``pause,'' ``reserve,'' or ``go'' command to the server, respectively.IfICCreserveis used, then thewhyvalue used in theICCpauseinvocation must match; the value used in theICCgoinvocation must always match that the one used in theICCpauseinvocation.The return value for all three routines is the same as forICCcommand.

If any routine described above fails, theICCfailurevariable will identify the system call that failed.

HISTORY

Written by Rich $alz <rsalzAATTuunet.uu.net> for InterNetNews.This is revision 1.10, dated 1993/01/29.

This document was created byman2html,using the manual pages.