Module ipc

Source
Available on crate feature managed-pts only.
Expand description

Launching pluggable transport binaries and communicating with them.

This module contains utilities to launch pluggable transports supporting pt-spec.txt version 1, and communicate with them in order to specify configuration parameters and receive updates as to the current state of the PT.

Modules§

sealed 🔒
Sealed trait to protect private types and default trait implementations

Structs§

PluggableClientTransport
A pluggable transport binary in a child process.
PluggableServerTransport
A pluggable transport server binary in a child process.
PtClientParameters
Parameters passed only to a pluggable transport client.
PtClientParametersBuilder
Builder for PtClientParameters.
PtCommonParameters
Common parameters passed to a pluggable transport.
PtCommonParametersBuilder
Builder for PtCommonParameters.
PtServerParameters
Parameters passed only to a pluggable transport server.
PtServerParametersBuilder
Builder for PtServerParameters.
PtStatus
An arbitrary key/value status update from a pluggable transport.

Enums§

PtClientParametersBuilderError
Error type for PtClientParametersBuilder
PtCommonParametersBuilderError
Error type for PtCommonParametersBuilder
PtMessage
A message sent from a pluggable transport child process.
PtServerParametersBuilderError
Error type for PtServerParametersBuilder

Constants§

GRACEFUL_EXIT_TIME 🔒
Amount of time we give a pluggable transport child process to exit gracefully.
PT_START_TIMEOUT 🔒
Default timeout for PT binary startup.
PT_STDIO_BUFFER 🔒
Size for the buffer storing pluggable transport stdout lines.

Traits§

PluggableTransport
Common functionality implemented to allow code reuse

Functions§

parse_one_smethod_arg 🔒
Chomp one key/value pair off a list of smethod args. Returns (k, v, unparsed rest of string). Will also chomp the comma at the end, if there is one.
parse_one_value 🔒
Parse a value (something on the RHS of an =), which could be a CString as defined by control-spec.txt §2. Returns (value, unparsed rest of string).