Below are all the paths you can subscribe to in Beacon.
/new/...
Subscription paths beginning with /new will not give you any initial state, you'll just get events that happen after you've subscribed.
/new/all
Subscribe for all new updates.
Returns
You'll receive entry and status updates as they occur.
/new/all/since/[stamp]
Subscribe for all new updates since the given stamp.
Returns
You'll receive entry and status updates for requests as the occur, but only for those with stamps later than the one specified.
Example
/new/all/since/1666875948253000000
/new/turf/[turf]
Subscribe for all new updates for the given turf (domain).
Important
When encoding a turf (domain) in a subscription or scry path, you must use ++wood encoding as described in this function, except without the leading ~.. If your domain does not contain unusual characters, just lowercase letters, numbers and hyphens, you can just put a tilde (~) before each dot separator rather than using the full function above.
Returns
You'll receive entry and status updates for requests as they occur, as long as they're for the specified turf.
Example
For example.com:
/new/turf/example~.com
For foo.bar-baz.com:
/new/turf/foo~.bar-baz.com
/new/turf/[turf]/since/[stamp]
Subscribe for all new updates for the given turf (domain), since the given stamp.
Important
When encoding a turf (domain) in a subscription or scry path, you must use ++wood encoding as described in this function, except without the leading ~.. If your domain does not contain unusual characters, just lowercase letters, numbers and hyphens, you can just put a tilde (~) before each dot separator rather than using the full function above.
Returns
You'll receive entry and status updates for requests as they occur, as long as they're for the specified turf and their stamp is sooner than the one specified in the path.
Example
/new/turf/example~.com/since/1666875948253000000
/new/ship/[ship]
Subscribe for all new updates for the given ship.
Returns
You'll receive entry and status updates for requests as the occur, but only for those that pertain to the specified ship.
Example
Note that the ship does not include the leading ~:
/new/ship/sampel-palnet
/new/ship/[ship]/since/[stamp]
Subscribe for all new updates for the given ship, since the given stamp.
Returns
You'll receive entry and status updates for requests as they occur, as long as they're for the specified ship and their stamp is sooner than the one specified in the path.
Example
Note that the ship does not include the leading ~:
/new/ship/sampel-palnet/since/1666875948253000000
/new/stamp/[stamp]
Subscribe for all new updates for the given stamp.
Returns
You'll receive entry updates and any status updates for the request with the given [stamp] as they occur.
Example
/new/stamp/1666875948253000000
/init/...
Subscription paths beginning with /init do the same as /new except they also give you initial state when you first subscribe.
/init/all
Subscribe for all new updates, and get the complete existing state of all requests.
Returns
You'll initially receive an initAll update containing the current state, and then you'll continue to receive entry and status updates as they occur.
/init/all/since/[stamp]
Subscribe to updates for requests that occurred after the specified stamp, and get the existing state of all requests with stamps later than the one specified.
Returns
You'll initially receive an initAll update containing the current state of requests later than the one specified. After that, you'll continue to receive entry and status updates as they occur, as long as they're for requests whose stamps are later than the one given.
Example
/init/all/since/1666875948253000000
/init/turf/[turf]
Subscribe to updates for requests pertaining to the given turf, and get the existing state of all requests pertaining to that turf.
Important
When encoding a turf (domain) in a subscription or scry path, you must use ++wood encoding as described in this function, except without the leading ~.. If your domain does not contain unusual characters, just lowercase letters, numbers and hyphens, you can just put a tilde (~) before each dot separator rather than using the full function above.
Returns
You'll initially receive an initTurf update containing the current state of requests for the given turf. After that, you'll continue to receive entry and status updates as they occur, as long as they're for that turf.
Example
/init/turf/example~.com
/init/turf/[turf]/since/[stamp]
Subscribe to updates for requests pertaining to the given turf, and get the existing state of all requests pertaining to that turf, as long as the stamp is later than the one given.
Important
When encoding a turf (domain) in a subscription or scry path, you must use ++wood encoding as described in this function, except without the leading ~.. If your domain does not contain unusual characters, just lowercase letters, numbers and hyphens, you can just put a tilde (~) before each dot separator rather than using the full function above.
Returns
You'll initially receive an initTurf update containing the current state of requests for the given turf with stamps later than the stamp given. After that, you'll continue to receive entry and status updates as they occur, as long as they're for that turf and have stamps later than the one specified.
Example
/init/turf/example~.com/since/1666875948253000000
/init/ship/[ship]
Subscribe to updates for requests pertaining to the given ship, and get the existing state of all requests pertaining to that ship.
Returns
You'll initially receive an initShip update containing the current state of requests for the given ship. After that, you'll continue to receive entry and status updates as they occur, as long as they're for that ship.
Example
/init/ship/sampel-palnet
/init/ship/[ship]/since/[stamp]
Subscribe to updates for requests pertaining to the given ship, and get the existing state of all requests pertaining to that ship, as long as the stamp is later than the one given.
Returns
You'll initially receive an initShip update containing the current state of requests for the given ship with stamps later than the stamp given. After that, you'll continue to receive entry and status updates as they occur, as long as they're for that ship and have stamps later than the one specified.
Example
/init/ship/sampel-palnet/since/1666875948253000000