1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
4 <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
5 <META NAME="GENERATOR" CONTENT="Mozilla/4.07 [en] (X11; I; Linux 2.2.13 i586) [Netscape]">
6 <TITLE>Undernet P10 Protocol and Interface Specification</TITLE>
11 <A NAME="top"></A><FONT SIZE=+3>Undernet P10 Protocol and Interface Specification</FONT></H2>
12 <I>(As of ircu 2.10.10)</I>
14 Undernet Coder-com, <TT>coder-com@undernet.org</TT></H2>
15 v0.10, 2nd March 2000.
17 <HR ALIGN=CENTER WIDTH=100% SIZE=2><I>This document aims to be a practical
18 guide for implementing and maintaining the protocol, not just a reference
20 <P>This document is "work in progress" and being continually updated :)
22 ALIGN=CENTER WIDTH=100% SIZE=2>
23 <BR><FONT SIZE=+2>1. <B><A HREF="#chap1">Introduction</A></B></FONT>
24 <P><FONT SIZE=+2>2. <B><A HREF="#chap2">General concepts and background</A></B></FONT>
25 <BLOCKQUOTE><FONT SIZE=+0>2.1 <A HREF="#chap2.1">Concepts</A>.</FONT>
26 <BR><FONT SIZE=+0>2.2 <A HREF="#chap2.2">Token Table</A>.</FONT></BLOCKQUOTE>
29 3. <A HREF="#chap3">Registration and syncronisation</A></H2>
33 <FONT SIZE=+0>3.1 <A HREF="#chap3.1">Server registration and authentication</A>.</FONT></LI>
36 <FONT SIZE=+0>3.2 <A HREF="#chap3.2">Network database resyncronisation</A>.</FONT></LI>
39 <FONT SIZE=+0>3.3 <A HREF="#chap3.3">Summary</A>.</FONT></LI>
43 4. <A HREF="#chap4">Continous operation</A></H2>
47 4.1 Channel operations.</LI>
53 4.3 Setting G-Lines.</LI>
60 4. Programmers reference: Function headers</H2>
64 <FONT SIZE=+0>4.1 ms_nick</FONT></LI>
67 <FONT SIZE=+0>4.2 m_burst</FONT></LI>
70 <FONT SIZE=+0>4.3 ..etc</FONT></LI>
74 5. <A HREF="#chap5">Programmers reference: Client/Server Structures</A></H2>
77 6. <A HREF="#chap7">FAQ</A></H2>
80 7. Acknowledgements and disclaimer</H2>
83 8. <A HREF="#chap8">Update History</A></H2>
87 <A HREF="#chap8.1">TODO List</A></LI>
91 <HR ALIGN=CENTER WIDTH=100% SIZE=2></CENTER>
93 <P><A NAME="chap1"></A><B><FONT SIZE=+2>1. Introduction</FONT></B>
94 <P><FONT FACE="Arial,Helvetica"><FONT SIZE=-1><B>[</B><A HREF="#top">Back</A><B>]</B></FONT></FONT>
96 <HR ALIGN=LEFT WIDTH=100% SIZE=2>
97 <P><A NAME="chap2"></A><B><FONT SIZE=+2>2. General concepts and background</FONT></B>
98 <P><A NAME="chap2.1"></A><B><FONT SIZE=+1>2.1 Concepts</FONT></B>
99 <P>The undernet P10 protocol uses a scheme of "Numerics" to uniquenly identify
100 a client or server within the network. Each server has its own unique numeric
101 (0 -> 4095) and each client has its own numeric within that server (0->262,143).
102 <P>The numerics are encoded into a Base64 stream to maintain human readable
103 data flow and reduce the size of the messages. The Base64 character set
104 used in ircu is included below, this defines all valid characters allowed
105 in a Base64 numeric with "A" representing 0 and "]" representing 63.
107 <PRE><TT><FONT COLOR="#00007F">ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789[]</FONT></TT></PRE>
109 Server numerics consist of 2 characters, with the minimum, 0, being represented
110 by "AA", and the maximum, 4095, being represented by "]]". Client numerics
111 are 3 characters long, with the minimum, 0, being represented by "AAA",
112 and the maximum, 262,143, being represented by "]]]". The unique identifier
113 of a client on the network consists of a combination of both the server
114 and client numeric in the format SSCCC.
115 <P>As an example, consider a server "irc.undernet.org" which has a numeric
116 of 2, translating to "AC" in Base64. On this server exists a client, whom
117 has been allocated the numeric 63 (which translates to "AA]" in Base64).
118 Therefore, the unique identifier of this client on the network is "ACAA]".
119 From this, we can determine which server the message came from, aswell
120 as the client who sent it.
121 <P>These numerics are used to prefix every message issued on the stream
122 except for the initial "PASS" or "SERVER" message, which are not prefixed.
123 Therefore, every message that can be recieved from a server will consist
126 <PRE><FONT COLOR="#00007F">[NUMERIC PREFIX] [TOKEN] [DATA]</FONT></PRE>
130 <PRE><FONT COLOR="#00007F">A[A5j P ABAAA :Foo.</FONT></PRE>
132 <A NAME="chap2.2"></A><B><FONT SIZE=+1>2.2 Token Table</FONT></B>
133 <P>The following table lists all the acceptable messages, along with their
134 relevant "Token", which is used in the server<>server protocol. The
135 aim of tokenisation is to reduce the bandwidth used during network communication
136 by reducing the length of common message identifiers.
138 <CENTER><TABLE BORDER COLS=2 WIDTH="40%" >
140 <TD><B>Message</B></TD>
142 <TD><B>Token</B></TD>
146 <TD><FONT SIZE=-1>PRIVMSG</FONT></TD>
148 <TD><FONT SIZE=-1>P</FONT></TD>
152 <TD><FONT SIZE=-1>WHO</FONT></TD>
154 <TD><FONT SIZE=-1>H</FONT></TD>
158 <TD><FONT SIZE=-1>WHOIS</FONT></TD>
160 <TD><FONT SIZE=-1>W</FONT></TD>
164 <TD><FONT SIZE=-1>WHOWAS</FONT></TD>
166 <TD><FONT SIZE=-1>X</FONT></TD>
170 <TD><FONT SIZE=-1>USER</FONT></TD>
172 <TD><FONT SIZE=-1>USER</FONT></TD>
176 <TD><FONT SIZE=-1>NICK</FONT></TD>
178 <TD><FONT SIZE=-1>N</FONT></TD>
182 <TD><FONT SIZE=-1>SERVER</FONT></TD>
184 <TD><FONT SIZE=-1>S</FONT></TD>
188 <TD><FONT SIZE=-1>LIST</FONT></TD>
190 <TD><FONT SIZE=-1>LIST</FONT></TD>
194 <TD><FONT SIZE=-1>TOPIC</FONT></TD>
196 <TD><FONT SIZE=-1>T</FONT></TD>
200 <TD><FONT SIZE=-1>INVITE</FONT></TD>
202 <TD><FONT SIZE=-1>I</FONT></TD>
206 <TD><FONT SIZE=-1>VERSION</FONT></TD>
208 <TD><FONT SIZE=-1>V</FONT></TD>
212 <TD><FONT SIZE=-1>QUIT</FONT></TD>
214 <TD><FONT SIZE=-1>Q</FONT></TD>
218 <TD><FONT SIZE=-1>SQUIT</FONT></TD>
220 <TD><FONT SIZE=-1>SQ</FONT></TD>
224 <TD><FONT SIZE=-1>KILL</FONT></TD>
226 <TD><FONT SIZE=-1>D</FONT></TD>
230 <TD><FONT SIZE=-1>INFO</FONT></TD>
232 <TD><FONT SIZE=-1>F</FONT></TD>
236 <TD><FONT SIZE=-1>LINKS</FONT></TD>
238 <TD><FONT SIZE=-1>LI</FONT></TD>
242 <TD><FONT SIZE=-1>STATS</FONT></TD>
244 <TD><FONT SIZE=-1>R</FONT></TD>
248 <TD><FONT SIZE=-1>HELP</FONT></TD>
250 <TD><FONT SIZE=-1>HELP</FONT></TD>
254 <TD><FONT SIZE=-1>ERROR</FONT></TD>
256 <TD><FONT SIZE=-1>Y</FONT></TD>
260 <TD><FONT SIZE=-1>AWAY</FONT></TD>
262 <TD><FONT SIZE=-1>A</FONT></TD>
266 <TD><FONT SIZE=-1>CONNECT</FONT></TD>
268 <TD><FONT SIZE=-1>CO</FONT></TD>
272 <TD><FONT SIZE=-1>MAP</FONT></TD>
274 <TD><FONT SIZE=-1>MAP</FONT></TD>
278 <TD><FONT SIZE=-1>PING</FONT></TD>
280 <TD><FONT SIZE=-1>G</FONT></TD>
284 <TD><FONT SIZE=-1>PONG</FONT></TD>
286 <TD><FONT SIZE=-1>Z</FONT></TD>
290 <TD><FONT SIZE=-1>OPER</FONT></TD>
292 <TD><FONT SIZE=-1>OPER</FONT></TD>
296 <TD><FONT SIZE=-1>PASS</FONT></TD>
298 <TD><FONT SIZE=-1>PA</FONT></TD>
302 <TD><FONT SIZE=-1>WALLOPS</FONT></TD>
304 <TD><FONT SIZE=-1>WA</FONT></TD>
308 <TD><FONT SIZE=-1>DESYNCH</FONT></TD>
310 <TD><FONT SIZE=-1>DS</FONT></TD>
314 <TD><FONT SIZE=-1>TIME</FONT></TD>
316 <TD><FONT SIZE=-1>TI</FONT></TD>
320 <TD><FONT SIZE=-1>SETTIME</FONT></TD>
322 <TD><FONT SIZE=-1>SE</FONT></TD>
326 <TD><FONT SIZE=-1>RPING</FONT></TD>
328 <TD><FONT SIZE=-1>RI</FONT></TD>
332 <TD><FONT SIZE=-1>RPONG</FONT></TD>
334 <TD><FONT SIZE=-1>RO</FONT></TD>
338 <TD><FONT SIZE=-1>NAMES</FONT></TD>
340 <TD><FONT SIZE=-1>E</FONT></TD>
344 <TD><FONT SIZE=-1>ADMIN</FONT></TD>
346 <TD><FONT SIZE=-1>AD</FONT></TD>
350 <TD><FONT SIZE=-1>TRACE</FONT></TD>
352 <TD><FONT SIZE=-1>TR</FONT></TD>
356 <TD><FONT SIZE=-1>NOTICE</FONT></TD>
358 <TD><FONT SIZE=-1>O</FONT></TD>
362 <TD><FONT SIZE=-1>WALLCHOPS</FONT></TD>
364 <TD><FONT SIZE=-1>WC</FONT></TD>
368 <TD><FONT SIZE=-1>CPRIVMSG</FONT></TD>
370 <TD><FONT SIZE=-1>CP</FONT></TD>
374 <TD><FONT SIZE=-1>CNOTICE</FONT></TD>
376 <TD><FONT SIZE=-1>CN</FONT></TD>
380 <TD><FONT SIZE=-1>JOIN</FONT></TD>
382 <TD><FONT SIZE=-1>J</FONT></TD>
386 <TD><FONT SIZE=-1>PART</FONT></TD>
388 <TD><FONT SIZE=-1>L</FONT></TD>
392 <TD><FONT SIZE=-1>LUSERS</FONT></TD>
394 <TD><FONT SIZE=-1>LU</FONT></TD>
398 <TD><FONT SIZE=-1>MOTD</FONT></TD>
400 <TD><FONT SIZE=-1>MO</FONT></TD>
404 <TD><FONT SIZE=-1>MODE</FONT></TD>
406 <TD><FONT SIZE=-1>M</FONT></TD>
410 <TD><FONT SIZE=-1>KICK</FONT></TD>
412 <TD><FONT SIZE=-1>K</FONT></TD>
416 <TD><FONT SIZE=-1>USERHOST</FONT></TD>
418 <TD><FONT SIZE=-1>USERHOST</FONT></TD>
422 <TD><FONT SIZE=-1>USERIP</FONT></TD>
424 <TD><FONT SIZE=-1>USERIP</FONT></TD>
428 <TD><FONT SIZE=-1>ISON</FONT></TD>
430 <TD><FONT SIZE=-1>ISON</FONT></TD>
434 <TD><I><FONT SIZE=-1>SQUERY</FONT></I></TD>
436 <TD><I><FONT SIZE=-1>SQUERY</FONT></I></TD>
440 <TD><I><FONT SIZE=-1>SERVLIST</FONT></I></TD>
442 <TD><I><FONT SIZE=-1>SERVLIST</FONT></I></TD>
446 <TD><I><FONT SIZE=-1>SERVSET</FONT></I></TD>
448 <TD><I><FONT SIZE=-1>SERVSET</FONT></I></TD>
452 <TD><FONT SIZE=-1>REHASH</FONT></TD>
454 <TD><FONT SIZE=-1>REHASH</FONT></TD>
458 <TD><FONT SIZE=-1>RESTART</FONT></TD>
460 <TD><FONT SIZE=-1>RESTART</FONT></TD>
464 <TD><FONT SIZE=-1>CLOSE</FONT></TD>
466 <TD><FONT SIZE=-1>CLOSE</FONT></TD>
470 <TD><FONT SIZE=-1>DIE</FONT></TD>
472 <TD><FONT SIZE=-1>DIE</FONT></TD>
476 <TD><FONT SIZE=-1>HASH</FONT></TD>
478 <TD><FONT SIZE=-1>HASH</FONT></TD>
482 <TD><FONT SIZE=-1>DNS</FONT></TD>
484 <TD><FONT SIZE=-1>DNS</FONT></TD>
488 <TD><FONT SIZE=-1>SILENCE</FONT></TD>
490 <TD><FONT SIZE=-1>U</FONT></TD>
494 <TD><FONT SIZE=-1>GLINE</FONT></TD>
496 <TD><FONT SIZE=-1>GL</FONT></TD>
500 <TD><FONT SIZE=-1>BURST</FONT></TD>
502 <TD><FONT SIZE=-1>B</FONT></TD>
506 <TD><FONT SIZE=-1>CREATE</FONT></TD>
508 <TD><FONT SIZE=-1>C</FONT></TD>
512 <TD><FONT SIZE=-1>DESTRUCT</FONT></TD>
514 <TD><FONT SIZE=-1>DE</FONT></TD>
518 <TD><FONT SIZE=-1>END_OF_BURST</FONT></TD>
520 <TD><FONT SIZE=-1>EB</FONT></TD>
524 <TD><FONT SIZE=-1>END_OF_BURST_ACK</FONT></TD>
526 <TD><FONT SIZE=-1>EA</FONT></TD>
530 <TD><FONT SIZE=-1>PROTO</FONT></TD>
532 <TD><FONT SIZE=-1>PROTO</FONT></TD>
536 <TD><FONT SIZE=-1>JUPE</FONT></TD>
538 <TD><FONT SIZE=-1>JU</FONT></TD>
541 <FONT FACE="Arial,Helvetica"><FONT SIZE=-1><B>[</B><A HREF="#top">Back</A><B>]</B></FONT></FONT>
543 <HR ALIGN=LEFT WIDTH=100% SIZE=2>
544 <P><A NAME="chap3"></A><B><FONT SIZE=+2>3. Registration and syncronisation</FONT></B>
545 <P><A NAME="chap3.1"></A><B><FONT SIZE=+1>3.1 Server registration and authentication</FONT></B>
546 <P>After a TCP connection has been established, the server initally introduces
547 itself via a "PASS" message as follows:
549 <PRE><FONT COLOR="#00007F">PASS :[PASSWORD]</FONT></PRE>
551 "PASSWORD" is simply compared with the password present in the destination
552 servers config file, and is used to confirm credentials after the "SERVER"
553 message has been recieved, as follows:
555 <PRE><TT><FONT COLOR="#00007F">SERVER [SERVERNAME] [HOPCOUNT] [START TIME] [LINK TIME] [PROTOCOL] [NUMERIC/MAXCONN] :[DESCRIPTION]</FONT></TT></PRE>
559 <PRE><B>1 2 3 4 5 6 7 8
560 </B>SERVER irc.undernet.org 1 933022556 947908144 J10 AA]]] :[127.0.0.1] A Undernet Server.</PRE>
565 The SERVER message, indicating this connection wishes to introduce a new
566 server to the network.</LI>
569 The name of the server you are introducing, a valid server name consists
573 The hop count of the server you are introducing, this is always 1
574 when you are introducing yourself.</LI>
577 The epoch timestamp specifying when the ircd was started.</LI>
580 The epoch timestamp specifying the time the server initiated the
581 link to the network.</LI>
584 The Protocol identifier of this server.</LI>
588 This token informs the network which protocol it is compliant with, eg:
589 If it is a P10 compliant server, then the token will be "P10".</LI>
592 If the server being introduced has not yet successfully synced its
593 database with the network (Completed its net.burst - see 3.2), then the
594 Protocol token should be prefixed with a J, instead of a P (Eg: J10) to
595 indicate it is currently still <B>j</B>oining the network.</LI>
598 The protocol token should always be JXX when the server is introducing
603 The numeric, and maximum connections identifier for this server.</LI>
607 This token is formatted exactly the same as a client numeric is formatted.
608 The first 2 characters identify the server's numeric, whilst in this situation,
609 the final 3 characters define the maximum number of clients that this server
610 can hold (and more importantly, the maximum number of numerics it will
614 The example "AA]]]" shows that this is a server with numeric 0, which
615 will generate client numerics up to 262,143.</LI>
619 This final parameter simply consists of a textual description of the server
620 prefixed by a colon. This is displayed in a clients WHOIS line, aswell
621 as in the LINKS reply.</LI>
623 <A NAME="chap3.2"></A><B><FONT SIZE=+1>3.2 Network Database resyncronisation</FONT></B>
624 <P>After the connection has been established and verified, the next step
625 is to syncronise the database of client/server/channel information between
627 <BLOCKQUOTE><B>3.2.1 - SERVER Messages</B></BLOCKQUOTE>
629 <BLOCKQUOTE>Server details are transmitted via "SERVER" messages similar
630 to the initial introduction message, with the following format:</BLOCKQUOTE>
633 <BLOCKQUOTE><TT><FONT COLOR="#00007F">[OWNING SERVER PREFIX] S [SERVERNAME]
634 [HOPCOUNT] [START TIME] [LINK TIME] [PROTOCOL] [NUMERIC/MAXCONN] 0 :[DESCRIPTION]</FONT></TT></BLOCKQUOTE>
635 <FONT COLOR="#000000">The syntax of this message is almost identical to
636 the originally recieved server message, with the only exception being that
637 the message is numeric prefixed, to indicate which server sent this message
638 (and also therefore, which hub this new server is linked too). There is
639 also a fixed "0" present before the Description field, this is a placeholder
640 for future use and currently unused.</FONT>
641 <P><B>3.2.2 - NICK Messages</B></BLOCKQUOTE>
643 <BLOCKQUOTE>Client information is transmitted via "NICK" messages, of the
644 following format:</BLOCKQUOTE>
648 <PRE><TT><FONT COLOR="#00007F">[NUMERIC PREFIX] N [NICK] [HOPCOUNT] [TIMESTAMP] [USERNAME] [HOST] <+modes> [BASE64 IP] [NUMERIC] :[USERINFO]</FONT></TT></PRE>
650 <FONT COLOR="#00007F">For Example:</FONT>
651 <BLOCKQUOTE><TT><FONT COLOR="#000000">1 2 3
652 4 5 6
653 7 8
654 9 10 11</FONT></TT>
655 <BR><TT><FONT COLOR="#000000">AF N Client1 1 947957573 User userhost.net
656 +oiwg DAqAoB AFAAA :Generic Client.</FONT></TT></BLOCKQUOTE>
660 The numeric of the server sending this message. (And hence, owning this
664 The "NICK" token.</LI>
667 The nickname of this client, currently max 9 chars.</LI>
670 The "Hopcount" of this client, Ie: how many servers away it is on.</LI>
673 The epoch timestamp indicating when the user was created.</LI>
676 The "User" part of the user@host mask.</LI>
679 the "Host" part of the user@host mask.</LI>
682 [<B>Optional</B>]: User modes. If present, this is always +<user modes
683 for this client>.</LI>
686 The real IP address of this client, a Base64 encoded 32bit int.</LI>
689 This client's numeric, in SSCCC format.</LI>
692 Free format user info line.</LI>
697 <BLOCKQUOTE><B>3.2.3 - BURST Messages</B></BLOCKQUOTE>
699 <BLOCKQUOTE>Channel details and membership information is synchronised
700 in one (or more) BURST messages for each channel that exists, formatted
701 as follows:</BLOCKQUOTE>
705 <PRE><TT><FONT COLOR="#00007F">[NUMERIC PREFIX] B [CHANNEL] [CREATION TIMESTAMP] <+MODES> <ARG1> <ARG2> [MEMBER LIST] <:%BANS></FONT></TT></PRE>
709 <BLOCKQUOTE>For Example:</BLOCKQUOTE>
713 <PRE>1 2 3 4 5 6 7 8 9
714 AZ B #coder-com 949217470 +tinkl key 56 AAAAA,AAAAB,AAAAC,ABAAA,ABAAB,ABAAC,ACAAA :%*!*@*.net</PRE>
718 <BLOCKQUOTE><I>Notes:</I></BLOCKQUOTE>
722 The numeric of the server sending this message.</LI>
725 The "BURST" token.</LI>
728 The name of the channel to which this data belongs. Currently #Channel
729 and +Channel names can be sent in a BURST message, &Channels are not
730 because by definition they are local to the server.</LI>
733 The epoch timestamp indicating when the channel was created.</LI>
736 [<B>Optional</B>]: Channel Modes.</LI>
740 The channel may have a number of modes set, aswell as relevant mode arguments
741 in the following 2 parameters.</LI>
745 [<B>Optional</B>]: Channel Key, this parameter is present if the channel
746 modes contain a "k" mode.</LI>
749 [<B>Optional</B>]: Channel Limit, this parameter is present if the channel
750 modes contain a "l" mode.</LI>
753 A <I>comma</I> seperated list of client numerics, with the following
754 specific formatting rules to indicate +o, +v and +ov channel members.</LI>
758 Numerics can have the following symbols appended on them; "<B>:ov</B>",
759 "<B>:v</B>" or "<B>:o</B>". These indicate that this numeric is either
760 Opped (<B>:o</B>), Voiced (<B>:v</B>) or both (<B>:ov</B>). This state
761 applies to the numeric it is attached too, and all subsequent numerics
762 until another state is encountered. <I>For Example:</I></LI>
765 AAABA:ov, AAABB:o,AAABC,AAABD,AAABE:v,AAABZ</LI>
767 <BR>Here, AAABA is both opped, and voiced, AAABB, AAABC and AAABD are opped
768 leaving AAABE and AAABZ voiced.
770 The first numeric of the member list will always contain a state
775 A <I>space</I> seperated list of bans present in the channel. The start
776 of the ban stream is indicated by a ":%", everything following the ":%"
777 is the ban list.</LI>
779 <BR><I>For Example:</I>
780 <BR>:%*!*@*.foobar.net another!ban@*.com *!*fred@a.host.co.uk
781 <BR>Would add the following bans to the channel:
783 <BR>another!ban@*.com
784 <BR>*!*fred@a.host.co.uk</OL>
786 <BLOCKQUOTE>If the length of a BURST message exceeds the maximum lenght
787 of a line (512 characters) then the remaining channel members/bans are
788 sent in subsequent BURST lines. The subsequent burst lines are <B>only</B>
789 used to add additional members to the channel, and if neccessary, channel
790 bans. There will be no "Mode" parameters present. A sample additional burst
791 line would be:</BLOCKQUOTE>
795 <PRE>AZ BURST #coder-com 949217470 ACAAB:o,ACAAD :%*!*another@*.ban.com</PRE>
799 <BLOCKQUOTE>Which adds two more opped members and a ban to the channel.</BLOCKQUOTE>
801 <BLOCKQUOTE><B>3.2.4 - JUPE Messages</B></BLOCKQUOTE>
803 <BLOCKQUOTE>Any currently unexpired JUPEs are transmitted via "JUPE"
804 messages with the following format:</BLOCKQUOTE>
807 <BLOCKQUOTE><TT><FONT COLOR="#00007F">[NUMERIC PREFIX] JU * (+|-)[SERVER NAME]
808 [LIFETIME] [LAST MOD] :[REASON]</FONT></TT></BLOCKQUOTE>
810 <BLOCKQUOTE><I>Notes:</I></BLOCKQUOTE>
814 The numeric of the server sending this message.</LI>
817 The "JUPE" token.</LI>
820 The target that should apply this JUPE (always "*" during bursts).</LI>
823 The name of the server to JUPE, prefixed with a "+" if the JUPE is active,
824 or with a "-" if it is not.</LI>
827 The remaining absolute lifetime of the JUPE, expressed in seconds.</LI>
830 The last time the JUPE was modified.</LI>
833 The reason the JUPE was applied.</LI>
837 <A NAME="chap3.3"></A><B><FONT SIZE=+1>3.3 Summary</FONT></B>
838 <P>The following table summarises the sequence of events that occur when
839 a server connects to another server. S1 is our server, and S2 is a HUB
840 on the target network.
841 <P>S1: Sends Password.
842 <BR>S1: Sends initial SERVER message.
843 <P><I>S2 Confirms S1 has the correct credentials, and if so, proceeds.
844 If not, S1 is squit with a relevant reason.</I>
845 <P>S2: Sends Password.
846 <BR>S2: Sends initial SERVER message.
847 <P><I>S1 Confirms S2 has the correct credentials, and if so, proceeds.
848 If not, S2 is squit with a relevant reason.</I>
849 <P><B><I>The follow occur asynchronously, however they have been shown
850 seperately below for simplicity.</I></B>
851 <P>S1: Sends all the servers it is aware of as a stream of SERVER messages.
852 <BR>S1: Sends all the clients it is aware of as a stream of NICK messages.
853 <BR>S1: Sends the database of channel states on the network, as a stream
855 <BR>S1: Sends all the jupes it is aware of as a stream of JUPE messages.
856 <BR>S1: Sends a END_OF_BURST token (EB) to indicate it has finished sending.
857 <P>S2: Sends all the servers it is aware of as a stream of SERVER messages.
858 <BR>S2: Sends all the clients it is aware of as a stream of NICK messages.
859 <BR>S2: Sends the database of channel states on the network, as a stream
861 <BR>S2: Sends all the jupes it is aware of as a stream of JUPE messages.
862 <BR>S2: Sends a END_OF_BURST token (EB) to indicate it has finished sending.
863 <P>S2: Sends an EOB_ACK token (EA) to indicate it has succesfully recieved
864 the END_OF_BURST from S1
865 <BR>S1: Sends an EOB_ACK token (EA) to indicate it has succesfully recieved
866 the END_OF_BURST from S2
867 <P><I>Example Session:</I>
868 <PRE><FONT COLOR="#00007F">[WRITE]: PASS :54321
869 [WRITE]: SERVER irc.undernet.org 1 947957852 947957852 J10 AB]]] :Undernet Client Server.
870 [WRITE]: AB N MrFoo 1 947957852 ~me myhost.foobar.net +diksw DAqAoB ABAAA :Mr Foo (foo@bar.com).
871 [WRITE]: AB B #mychannel 946101324 ABAAA:o
874 [ READ]: SERVER server1.undernet.org 1 947901540 947958150 J10 AFAD] :A Generic Server.
875 [ READ]: AF S server2.undernet.org 2 0 947957585 P10 AZAD] 0 :[192.168.10.3] A Generic Server.
876 [ READ]: AZ S server3.undernet.org 3 0 947957607 P10 AIAD] 0 :[192.168.10.5] A Generic Server.
877 [ READ]: AF N Client1 1 947957573 Ident userhost.net +oiwg DAqAoB AFAAA :Generic Client.
878 [ READ]: AZ N Client2 2 947957719 Ident userhost.net +iwg DAqAoB AZAAA :Generic Client.
879 [ READ]: AI N Client3 3 947957742 Ident userhost.net +iwg DAqAoB AIAAA :Generic Client.
880 [ READ]: AI N Client4 3 947958121 Ident userhost.net +iwg DAqAoB AIAAB :Generic Client.
881 [ READ]: AF B #foobar 947957734 +tink akey AIAAB,AIAAA:v,AZAAA:o :%*!*another@*.ban.com *!*foo@bar.net
882 [ READ]: AF B #coder-com 947957727 AIAAB,AZAAA:o
883 [ READ]: AF B #another 946101321 AFAAA
884 [ READ]: AF JU * +juped.undernet.org 3600 947958100 :Broken, please fix
887 [ READ]: AF EA</FONT></PRE>
888 <FONT FACE="Arial,Helvetica"><FONT SIZE=-1><B>[</B><A HREF="#top">Back</A><B>]</B></FONT></FONT>
891 <BR><A NAME="chap4"></A><B><FONT SIZE=+2>4. Continuous Operation</FONT></B>
892 <P><FONT FACE="Arial,Helvetica"><FONT SIZE=-1><B>[</B><A HREF="#top">Back</A><B>]</B></FONT></FONT>
894 <HR ALIGN=LEFT WIDTH=100% SIZE=2>
895 <P><A NAME="chap5"></A><B><FONT SIZE=+2>5. Programmers reference: Client/Server
896 Structures</FONT></B>
897 <P>This section provides information on the standard Client/Server structures,
898 for easy reference during development.
899 <P><I>[..Link to autogenerated struct.html..]</I>
900 <P><FONT FACE="Arial,Helvetica"><FONT SIZE=-1><B>[</B><A HREF="#top">Back</A><B>]</B></FONT></FONT>
902 <HR ALIGN=LEFT WIDTH=100% SIZE=2>
903 <BR><A NAME="chap7"></A><B><FONT SIZE=+2>7. FAQ</FONT></B>
904 <P>Frequently asked questions.
912 <FONT FACE="Arial,Helvetica"><FONT SIZE=-1><B>[</B><A HREF="#top">Back</A><B>]</B></FONT></FONT>
915 <P><A NAME="chap8"></A><B><FONT SIZE=+2>8. Update History</FONT></B>
916 <P>[20/01/2000]: Initial draft, structure, background info.
917 <BR>[13/02/2000]: Added initial BURST documentation.
918 <BR>[14/02/2000]: Continued BURST documentation / Begin NICK and SERVER
920 <BR>[26/02/2000]: Continued chapter 5, few example fixes, added token table
922 <BR>[02/03/2000]: Added NICK spec. --Gte.
923 <BR>[18/03/2000]: Added JUPE spec. -Kev
924 <P><A NAME="chap8.1"></A><B><FONT SIZE=+1>8.1 TODO</FONT></B>
927 Finish Chapter 5.</LI>
930 Go through examples, and ensure they are all correct.</LI>
933 Add common function headers, with argv listings.</LI>
936 Add description of further server<>server messages, with special cases
940 Add FAQ Section.</LI>
943 Any chance we could switch to ISO dates (2000-3-18)? ;) -Kev.</LI>
945 <FONT FACE="Arial,Helvetica"><FONT SIZE=-1><B>[</B><A HREF="#top">Back</A><B>]</B></FONT></FONT>