Syntax
:samp:`[{SCHEME}:[//{HOST}[:{PORT}]]][{PATH}][?{QUERY}][#{FRAGMENT}]`
Components of the URL are interpreted as follows:
- :samp:`{SCHEME}`
- :term:`transport` name (e.g
spread) - :samp:`{HOST}`
- :term:`transport`-specific "host" option (e.g. host that runs the :term:`daemon <spread daemon>` for :term:`Spread` :term:`transport`)
- :samp:`{PORT}`
- :term:`transport`-specific "port" option (e.g. port on which :term:`daemon <spread daemon>` listens for :term:`Spread` :term:`transport`)
- :samp:`{PATH}`
A :term:`scope` which designates one of the following things
- :samp:`{QUERY}`
- "freestyle" :term:`transport`-specific options
- :samp:`{FRAGMENT}`
- Not allowed when designating a :term:`channel`
- ID of a :term:`participant` otherwise
Note
While URLs in general allow specifying host and port components
without specifying a scheme (e.g. //myhost:1234), this is not
allowed in the context of |project|.
Syntax
:samp:`rsb:[{PATH}][#{FRAGMENT}]`
Warning
Generic URIs are not currently used and their potential semantics have not yet been specified.
The following examples demonstrate how to specify bus connections when creating :term:`participants <participant>`:
`` ``
Participate in :term:`channel` with :term:`scope`/using the default :term:`transport` configuration.
spread:Participate in :term:`channel` with :term:`scope`/using the :term:`Spread` :term:`transport` with its default configuration.
inprocess:Participate in :term:`channel` with :term:`scope`/using the in-process :term:`transport` with its default configuration.
spread://localhost:5555Participate in :term:`channel` with :term:`scope`/via the :term:`Spread` daemon running on localhost and listening on port 5555.
inprocess://someotherhostSyntactically correct, but does not make sense.
spread:/foo/barParticipate in :term:`channel` with :term:`scope`/foo/barusing the default :term:`transport` configuration.
spread:?maxfragmentsize=10000Participate in :term:`channel` with :term:`scope`/using the :term:`Spread` :term:`transport` with default host and port and a maximum event fragment size of 10000 bytes.
spread:?maxfragmentsize=10000&tcpnodelay=yesLikewise, but in addition with tcpnodelay option set toyes.
//myhost:1234Illegal because there is no scheme component.
| Language | File(s) |
|---|---|
| C++ | not yet implemented |
| Java | not yet implemented |
| Python | not yet implemented |
| Common Lisp | :download:`upstream/rsb-cl/src/uris.lisp` |