Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sgherbst committed Nov 3, 2023
1 parent f74830c commit e7704f2
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,3 +143,16 @@ The `last` indicator (part of the `flags` bit vector) indicates whether there is
<img width="253" alt="image" src="https://user-images.githubusercontent.com/19254098/225485752-59cd02f3-6877-4cbd-960c-823276d8a815.png">

The purpose of `last` is two-fold. For one, it simplifies the process of transmitting "burstable" protocols such as UMI through Switchboard. It also provides opportunities for performance optimization. For example, if a long sequence of SB packets is being sent over TCP, the TCP bridge knows it can wait to fill up its transmission buffer as long as `last=0`. Without the `last` bit, the bridge would have to send each packet one at a time (or wait a predefined time for more packets), since any given packet may be the last one.

## License

[MIT License](LICENSE)

## Contributing

switchboard is an open-source project and welcomes contributions. To find out how to contribute to the project, see our
[Contributing Guidelines](CONTRIBUTING.md).

## Issues / Bugs

We use [GitHub Issues](https://github.com/zeroasiccorp/switchboard/issues) for tracking requests and bugs.

0 comments on commit e7704f2

Please # to comment.