Skip to main content

Module ipt_establish

Module ipt_establish 

Source
Expand description

IPT Establisher

Responsible for maintaining and establishing one introduction point.

TODO (#1235): move docs from hssvc-ipt-algorithm.md

See the docs for IptManager::idempotently_progress_things_now for details of our algorithm.

Structsยง

EstIntroExtensionSet ๐Ÿ”’
A set of extensions to send with our ESTABLISH_INTRO message.
EstablisherState ๐Ÿ”’
State shared between the IptEstablisher and the Reactor.
GoodIptDetails ๐Ÿ”’
Details of a good introduction point
IntroPtSession ๐Ÿ”’
An open session with a single introduction point.
IptEstablisher ๐Ÿ”’
Handle onto the task which is establishing and maintaining one IPT
IptMsgHandler ๐Ÿ”’
MsgHandler type to implement a conversation with an introduction point.
IptParameters ๐Ÿ”’
Parameters for an introduction point
IptStatus ๐Ÿ”’
The current status of an introduction point.
IptWantsToRetire ๐Ÿ”’
Err(IptWantsToRetire) indicates that the IPT Establisher wants to retire this IPT
Reactor ๐Ÿ”’
Implementation structure for the task that implements an IptEstablisher.
StreamWasFull ๐Ÿ”’
We failed to send a rendezvous request onto the handler test that should have handled it, because it was not handling requests fast enough.

Enumsยง

IptError
An error caused by a faulty IPT.
IptEstablisherError ๐Ÿ”’
An error from trying to work with an IptEstablisher.
IptMsg ๐Ÿ”’
An acceptable message to receive from an introduction point.
IptStatusStatus ๐Ÿ”’
The current status of an introduction point, as defined in hssvc-ipt-algorithms.md.
RequestDisposition ๐Ÿ”’
Current state of an introduction point; determines what we want to do with any incoming messages.

Constantsยง

FAULTY_IPT_THRESHOLD ๐Ÿ”’
We declare an introduction point to be faulty if all of the attempts to reach it fail, over this much time.