4 inndcomm \- INND communication part of InterNetNews library
7 .ta \w' unsigned long 'u
22 .B "ICCcommand(cmd, argv, replyp)"
28 .B "ICCcancel(mesgid)"
43 .B "extern char *ICCfailure;"
46 The routines described in this manual page are part of the InterNetNews
49 They are used to send commands to a running
51 daemon on the local host.
52 The letters ``ICC'' stand for
59 Unix-domain datagram socket and binds it to the server's control socket, if
60 .I <HAVE_UNIX_DOMAIN_SOCKETS in include/config.h>
61 is defined. Otherwise it creates
62 a named pipe for communicating with the server.
63 It returns \-1 on failure or zero on success.
64 This routine must be called before any other routine.
67 closes any descriptors that have been created by
69 It returns \-1 on failure or zero on success.
72 can be called before any of the following routines to determine how long
73 the library should wait before giving up on getting the server's reply.
74 This is done by setting and catching a SIGALRM
76 If the timeout is less then zero then no reply will be waited for.
77 The SC_SHUTDOWN, SC_XABORT, and SC_XEXEC commands do not get a reply either.
78 The default, which can be obtained by setting the timeout to zero, is to
79 wait until the server replies.
87 It returns \-1 on error.
88 If the server replies, and
90 is not NULL, it will be filled in with an allocated buffer that contains
91 the full text of the server's reply.
92 This buffer is a string in the form of ``<digits><space><text>''
93 where ``digits'' is the text value of the recommended exit code;
94 zero indicates success.
95 Replies longer then 4000 bytes will be truncated.
96 The possible values of
98 are defined in the ``inndcomm.h'' header file.
99 The parameters for each command are described in
101 This routine returns \-1 on communication failure, or the exit status
102 sent by the server which will never be negative.
105 sends a ``cancel'' message to the server.
107 is the Message-ID of the article that should be canceled.
108 The return value is the same as for
115 send a ``pause,'' ``reserve,'' or ``go'' command to the server, respectively.
122 invocation must match; the value used in the
124 invocation must always match that the one used in the
127 The return value for all three routines is the same as for
130 If any routine described above fails, the
132 variable will identify the system call that failed.
134 Written by Rich $alz <rsalz@uunet.uu.net> for InterNetNews.
136 This is revision \\$3, dated \\$4.
138 .R$ $Id: inndcomm.3 1586 1998-12-09 15:53:55Z kondou $