0006-protocol-naming-conventions

2026-04-02 03:38:42 -07:00 · 2021-05-13 14:35:30 -04:00
parent 924b314a79
commit afc279705f
1 changed files with 56 additions and 0 deletions
--- a/doc/adr/0006-protocol-naming-conventions.md
+++ b/doc/adr/0006-protocol-naming-conventions.md
@@ -0,0 +1,56 @@
+# 6. protocol-naming-conventions
+
+Date: 2021-05-08
+
+## Status
+
+Under Review
+
+## Context
+
+This document describes naming conventions for these protocol components:
+
+* message subject
+* stream name
+* reply to
+* queue name
+* durable name
+* account name
+
+## Prior Work
+
+Currently the NATS Docs regarding [protocol convention](https://docs.nats.io/nats-protocol/nats-protocol#protocol-conventions) says this:
+
+> Subject names, including reply subject (INBOX) names, are case-sensitive and must be non-empty alphanumeric strings with no embedded whitespace. All ascii alphanumeric characters except spaces/tabs and separators which are "." and ">" are allowed. Subject names can be optionally token-delimited using the dot character (.), e.g.:
+A subject is comprised of 1 or more tokens. Tokens are separated by "." and can be any non space ascii alphanumeric character. The full wildcard token ">" is only valid as the last token and matches all tokens past that point. A token wildcard, "*" matches any token in the position it was listed. Wildcard tokens should only be used in a wildcard capacity and not part of a literal token.
+
+> Character Encoding: Subject names should be ascii characters for maximum interoperability. Due to language constraints and performance, some clients may support UTF-8 subject names, as may the server. No guarantees of non-ASCII support are provided.
+
+## Specification
+
+```
+dot              = "."
+asterisk         = "*"
+lt               = "<"
+gt               = ">"
+dollar           = "$"
+colon            = ":"
+double-quote     = ["]
+fwd-slash        = "/"
+backslash        = "\"
+pipe             = "|"
+question-mark    = "?"
+ampersand        = "&"
+printable        = all printable ascii (33 to 126 inclusive)
+term             = (printable except dot, asterisk or gt)+
+prefix           = (printable except dot, asterisk, gt or dollar)+
+filename-safe    = (printable except dot, asterisk, lt, gt, colon, double-quote, fwd-slash, backslash, pipe, question-mark, ampersand)
+
+message-subject  = term (dot term | asterisk)* (dot gt)?
+reply-to         = term (dot term)*
+stream-name      = term
+queue-name       = term
+durable-name     = term
+jetstream-prefix = prefix
+account-name     = (filename-safe)+ maximum 255 characters
+```