SHV RPC RI

This is definition of Resource Identifiers for SHV RPC. SHV has two types of resources; those are methods and signals.

Resource identifiers are human readable and are used thorough this documentation as well as in the broker's signal filtering. They can also be used by other tools.

The format is either PATH:METHOD for methods or PATH:METHOD:SIGNAL for signals.

The first field PATH is the SHV path. It can be glob pattern (rules from POSIX.2, 3.13 with added support for ** that matches multiple nodes). In contrast to the Bash globstar implementation, the SHV glob-star pattern ** matches zero or more directories at the end of the path. For example foo/** matches foo, foo/bar, foo/bar/baz, etc. By comparison, Bash’s foo/** pattern matches foo/bar and foo/bar/baz, but not foo itself. Note that empty PATH is the root of the SHV node tree.

The second field METHOD is the SHV RPC method name. It can be wildcard pattern (rules from POSIX.2, 3.13). The empty method name is invalid and thus is invalid pattern.

The third field SIGNAL that is used only for signals is the SHV RPC signal name while METHOD in such case is its source. It can be wildcard pattern (rules from POSIX.2, 3.13). The empty signal name is invalid and thus is invalid pattern.

The examples of Resource Identifiers for methods and method matching:

The examples of Resource Identifiers for signals and signals matching: