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

NIAD-2785: Add timeout section to operating doc #339

Merged
merged 4 commits into from
Oct 24, 2023

Conversation

benhession
Copy link
Contributor

@benhession benhession commented Oct 23, 2023

What

Add a section to OPERATING.md for the Timeout functionality

Why

The NME must configure the timeout functionality correctly to end "stuck" transfers.

Type of change

Please delete options that are not relevant.

  • Internal change (non-breaking change with no effect on the functionality affecting end users)

Checklist:

  • I have performed a self-review of my code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • New and existing unit tests pass locally with my changes

@benhession benhession marked this pull request as ready for review October 23, 2023 13:17
OPERATING.md Outdated Show resolved Hide resolved
OPERATING.md Outdated Show resolved Hide resolved
OPERATING.md Outdated
@@ -20,6 +20,45 @@ yyyy-mm-dd HH:mm:ss.SSS Level=DEBUG Logger=u.n.a.p.t.s.BundleMapperService Conve

## Timeout functionality

The Adaptor conforms to the GP2GP large messaging specification (NPFIT-PC-BLOD-0170.03 v1.1)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NPFIT-PC-BLOD-0170.03 v1.1 doesn't return any google results 😭. Is there a more "user facing" name for that spec?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The document is just called Handling Large Messages. I think it might not be available publicly, so I'll remove the reference to it.

OPERATING.md Outdated Show resolved Hide resolved
OPERATING.md Outdated Show resolved Hide resolved
OPERATING.md Outdated Show resolved Hide resolved
@benhession benhession enabled auto-merge (squash) October 23, 2023 16:16
Copy link
Collaborator

@adrianclay adrianclay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! :shipit:

@benhession benhession merged commit ebcad02 into main Oct 24, 2023
@benhession benhession deleted the NIAD-2785-add-timeout-section-to-operating-doc branch October 24, 2023 07:55
Copy link
Contributor

@HarveySembhyNHS HarveySembhyNHS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants