Skip to content

Commit a8eb127

Browse files
committed
Add extended-isupport
1 parent c9ff1a8 commit a8eb127

File tree

1 file changed

+71
-0
lines changed

1 file changed

+71
-0
lines changed

extensions/extended-isupport.md

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
title: "`extended-isupport` Extension"
3+
layout: spec
4+
copyrights:
5+
-
6+
name: "Simon Ser"
7+
period: "2024"
8+
9+
---
10+
11+
## Notes for implementing work-in-progress version
12+
13+
This is a work-in-progress specification.
14+
15+
Software implementing this work-in-progress specification MUST NOT use the
16+
unprefixed `extended-isupport` capability name. Instead, implementations SHOULD
17+
use the `draft/extended-isupportt` capability name to be interoperable with
18+
other software implementing a compatible work-in-progress version. The final
19+
version of the specification will use unprefixed capability names.
20+
21+
## Introduction
22+
23+
`RPL_ISUPPORT` is used to advertise metadata about the server as key-value
24+
entries. However, `RPL_ISUPPORT` is only sent by servers after connection
25+
registration. This undermines the usefulness of `RPL_ISUPPORT`: some of the
26+
metadata would be useful to clients prior to connection registration. This
27+
extension adds a mechanism to send `RPL_ISUPPORT` messages before connection
28+
registration, as well as an end of `RPL_ISUPPORT` list indication.
29+
30+
## Implementation
31+
32+
### `draft/extended-isupport` capability
33+
34+
When the `draft/extended-isupport` capability is enabled by the client, the
35+
server MUST send one or more `RPL_ISUPPORT` messages (grouped inside a
36+
`draft/isupport` batch if the `batch` capability is enabled). While
37+
`draft/extended-isupport` is enabled, the server MAY send updates to the
38+
key-value entries via subsequent `RPL_ISUPPORT` messages.
39+
40+
The server MAY skip the `RPL_ISUPPORT` replies usually sent when connection
41+
registration completes, if it already sent all information.
42+
43+
Before connection registration, the server MAY send only a subset of the full
44+
`RPL_ISUPPORT` list. In that case, the server MUST send a `RPL_ISUPPORT` list
45+
when connection registration completes with entries previously omitted.
46+
47+
### `draft/isupport` batch
48+
49+
The server MUST group all `RPL_ISUPPORT` messages inside a `draft/isupport`
50+
batch when the [`batch`][] and `draft/extended-isupport` capabilities are
51+
enabled.
52+
53+
The batch MUST only contain one or more `RPL_ISUPPORT` messages.
54+
55+
## Examples
56+
57+
Enabling the capability:
58+
59+
C: CAP LS 302
60+
S: :irc.example.org CAP * LS :multi-prefix sasl draft/extended-isupport
61+
C: CAP REQ draft/extended-isupport
62+
S: :irc.example.org CAP * ACK draft/extended-isupport
63+
S: :irc.example.org BATCH +asdf draft/isupport
64+
S: @batch=asdf :irc.example.org 005 * NETWORK=Example NICKLEN=30
65+
S: :irc.example.org BATCH -asdf
66+
67+
Sending a change:
68+
69+
S: :irc.example.org BATCH +asdf draft/isupport
70+
S: @batch=asdf :irc.example.org 005 * CHANNELLEN=64 -NETWORK
71+
S: :irc.example.org BATCH -asdf

0 commit comments

Comments
 (0)