Status of the bus. This api exposes information regarding applications connected to the bus. This is a read-only API. The Names API does not load persistent data from the backend, all nodes are generated at run time.
The Names API is accessed through the names property of a connected IWC Client.
var iwc = new ozpIwc.Client("http://localhost:13000);
var names = iwc.names;
The IWC uses the concept of references when accessing resources. References are objects with auto-generated functionality to perform actions on a given resource.
To create a reference to a resource, use the Reference constructor of the
desired api, names in this case, with a string of the resource path:
var routerRef = new iwc.names.Reference("/router");
| Action | has Callback? | Description |
|---|---|---|
| get | no | gathers the node with the specific key |
| bulkGet | no | gathers all nodes who's key matches the given partial-key |
| list | no | gathers all node keys who match the given partial-key |
| set | no | stores the given value to the specified node |
| delete | no | deletes the node with the specific key |
| watch | yes | gathers the node with the specific key and calls the registered callback on updates to the node |
| unwatch | no | unregisters the callback for the node |
The Names API relies on the path-level separation node scheme to easily separate differences in resources.
The table below breaks down the differences in each level.
All of the following node keys can be gathered as collections using the list action (see Listing Resources)
/api/{address}: An API on the bus. Contains an array of actions pertaining to the API.
/address/{address}: A connection to the bus. All components of the IWC bus have an assigned address. Contains information on the component assigned to the address.
/multicast/{group}/{member}: A group-specific multicast member. Multicast messages are distributed to all members of the group (internal messaging not client messaging). Contains information on the component assigned to the address.
/router/{address}: A router connected to the IWC bus. Each window has a router to distribute messages amongst its participants. Contains information on its participants.
| Node | Content Type | set | get | delete |
|---|---|---|---|---|
| /api/{address} | application/vnd.ozp-iwc-api-v1+json | no | yes | no |
| /address/{address} | application/vnd.ozp-iwc-address-v1+json | no | yes | no |
| /multicast/{group}/{member} | application/vnd.ozp-iwc-multicast-address-v1+json | no | yes | no |
| /router/{address} | application/vnd.ozp-iwc-router-v1+json | no | yes | no |
Requesting an action on a node that does not fit the given node structure will result in a response of
"badResource";