Debian Codegraph @

help/on/dcc_raw

raw
1 ! $eterna: dcc_raw,v 1.7 2018/06/10 08:17:42 mrg Exp $
2 !
3 ! Copyright (c) 1990-2018 Michael Sandrof, Troy Rollo, Matthew Green,
4 ! and other ircII contributors.
5 !
6 ! All rights reserved. See the HELP IRCII COPYRIGHT file for more
7 ! information.
8 !
9 Usage: ON [#|+|-|^|&|@]DCC_RAW [-|^]<paramters> [action]
10 This is activated whenever you receive a raw message from
11 a tcp connection established with $CONNECT().
12 The parameters for the action are as follows:
13 $0 file descriptor for the connection.
14 $1 host name in connection
15 $2 code as listed below
16 $3- data or port number depending on code.
17
18 Incoming messages can be intercepted with ON DCC_RAW,
19 which has the following formats:
20
21 fd host D data
22 fd host C
23 fd host N port
24 fd host E port
25
26 The D message indicates incoming data.
27 The C message indicates that the socket has been closed.
28 The N message indicates that a socket listening on the
29 specified port has accepted a connection. fd in this case
30 is the file descriptor for the new connection.
31 The E message is generated when a CONNECT() results in a
32 successful connection.
33
34 Conventions to be used for the socket access:
35
36 Scripts using sockets should never use the
37 serial number 0 in their hooks. As their first
38 act before using the DCC_RAW hooks, they should
39 set:
40
41 ON ^DCC_RAW * #
42
43 To ensure that all raw DCC sockets produce no
44 output.
45
46 A new set of hooks should be created for each
47 active socket at a chosen serial number. One
48 must always exist to detect the close message,
49 and as its last act must remove all the hooks
50 for that file descriptor.
51
52 See Also:
53 DCC RAW
54 ALIAS FUNCTIONS