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

Descriptive "time blocks" in sequence diagrams #4549

Open
kianhub opened this issue Jun 27, 2023 · 0 comments
Open

Descriptive "time blocks" in sequence diagrams #4549

kianhub opened this issue Jun 27, 2023 · 0 comments
Labels
Status: Triage Needs to be verified, categorized, etc Type: Enhancement New feature or request

Comments

@kianhub
Copy link

kianhub commented Jun 27, 2023

Proposal

As an network analyst, I want to highlight a block of time in which certain messages are sent.

For timeline blocks I'd like to define the following within my sequence diagram to indicate a block that renders during which timeframe messages are sent.

Syntax proposal:
timeblock [arrow at start | arrow at end | arrows | line at start | line at end | lines]: [timeblock-title | empty]

Example

sequenceDiagram
        timeblock arrows Timeout
	HostA ->> HostB: Seq=92, 8 bytes data
	HostB --x HostA: ACK=100
	Note right of HostB: ACK is lost
	end
	HostA ->> HostB: Seq=92, 8 bytes data
	HostB ->> HostA: ACK=100
	Note left of HostA: SendBase = 100

The first message after a timeblock (displayed as two arrows vertically up and down, "timeout" in between) indicates the start of the timeblock while the first message after the end of a timeblock displays the end of it.

Screenshots

image
@kianhub kianhub added Status: Triage Needs to be verified, categorized, etc Type: Enhancement New feature or request labels Jun 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Triage Needs to be verified, categorized, etc Type: Enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant