Skip to content
This repository has been archived by the owner on Jul 19, 2020. It is now read-only.

Commit

Permalink
update the docs to specify that local agents do not incur serializati…
Browse files Browse the repository at this point in the history
…on overhead (#89)
  • Loading branch information
mkawalec authored May 26, 2020
1 parent a57370b commit 44c7fd4
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions src/concepts/agents.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Yew's Actor System

# Agents

Agents are similar to Angular's [Services](https://angular.io/guide/architecture-services) \(but without dependency injection\), and provide a Yew with an [Actor Model](https://en.wikipedia.org/wiki/Actor_model). Agents can be used to route messages between components independently of where they sit in the component hierarchy, or they can be used to create a global state, and they can also be used to offload computationally expensive tasks from the main thread which renders the UI. There is also planned support for using agents to allow Yew applications to communicate accross tabs \(in the future\).
Agents are similar to Angular's [Services](https://angular.io/guide/architecture-services) \(but without dependency injection\), and provide a Yew with an [Actor Model](https://en.wikipedia.org/wiki/Actor_model). Agents can be used to route messages between components independently of where they sit in the component hierarchy, or they can be used to create a shared state, and they can also be used to offload computationally expensive tasks from the main thread which renders the UI. There is also planned support for using agents to allow Yew applications to communicate accross tabs \(in the future\).

In order for agents to run concurrently, Yew uses [web-workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Using_web_workers).

Expand All @@ -16,10 +16,10 @@ In order for agents to run concurrently, Yew uses [web-workers](https://develope

#### Reaches

* Context - There will exist at most one instance of a Context Agent at any given time. Bridges will spawn or connect to an already spawned agent on the UI thread. This can be used to coordinate state between components or other agents. When no bridges are connected to this agent, the agent will disappear.
* Job - Spawn a new agent on the UI thread for every new bridge. This is good for moving shared but independent behavior that communicates with the browser out of components. \(TODO verify\) When the task is done, the agent will disappear.
* Context - Bridges will spawn or connect to an agent on the UI thread. This can be used to coordinate with state between components or other agents. When no bridges are connected to this agent, the agent will disappear.
* Private - Same as Job, but runs on its own web worker.
* Public - Same as Context, but runs on its own web worker.
* Private - Same as Job, but runs on its own web worker.
* Global \(WIP\)

## Communication between Agents and Components
Expand All @@ -30,11 +30,11 @@ A bridge allows bi-directional communication between an agent and a component. B

### Dispatchers

A dispatcher allows uni-directional communication between a component and an agent. A bridge allows a component to send messages to an agent.
A dispatcher allows uni-directional communication between a component and an agent. A dispatcher allows a component to send messages to an agent.

## Overhead

Agents communicate by serializing their messages using [bincode](https://github.com/servo/bincode). So there is a higher performance cost than just calling functions. Unless the cost of computation or the need to coordinate across arbitrary components will outweigh the cost of message passing, you should contain your logic to functions where possible.
Agents that live in their own separate web worker (Private and Public) incur serialization overhead on the messages they send and receive. They use [bincode](https://github.com/servo/bincode) to communicate with other threads, so the cost is substantially higher than just calling a function. Unless the cost of computation will outweigh the cost of message passing, you should contain your logic in the UI thread agents (Job or Context).

## Further reading

Expand Down

0 comments on commit 44c7fd4

Please sign in to comment.