Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Describe how custom transport could be defined in PPSPP URI #44

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion doc/content/url.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,15 @@ simple structure has been used, based off a quick reading of
[Guidelines for new URL Schemes](https://tools.ietf.org/html/rfc2718) and
[URI Generic Syntax](https://tools.ietf.org/html/rfc3986).

- `scheme`: defines the protocol in use, always `ppspp`
- `scheme`: defines the protocol in use, by default `ppspp`. The PPSPP
specification declares protocol to be transport agnostic: it may use UDP or
SCTP or something else. While for now only UDP transport is defined as base
one, in future this may change. To handle PPSPP-over-Proto situations, custom
transport MUST be defined after `+` character, like: `ppspp+sctp` which reads
as "use PPSPP protocol over SCTP transport".
By default UDP protocol is assumed and MUST be used, while `ppspp+udp` is
still valid scheme.

- `authority`: the IP address and port `example.net:7777`
- `path`: the root hash in use, or requested filename `c89800bf` or `messier74.jpg`
- optional `query` string: supports passing swarm options such as: `content_integrity_protection_method=merkle_hash_tree &merkle_hash_tree_function=sha-256`
Expand Down