Module session

Source
Expand description

Types for working with the ngrok session.

Structs§

CommandResp
Common response structure for all remote commands originating from the ngrok dashboard.
InvalidHeartbeatInterval
The builder specified an invalid heartbeat interval.
InvalidHeartbeatTolerance
The builder specified an invalid heartbeat tolerance.
InvalidServerAddr
The builder provided an invalid server address
ProxyUnsupportedError
An unsupported proxy address was provided.
Restart
A request from the ngrok dashboard for the agent to restart.
Session
An ngrok session.
SessionBuilder
The builder for an ngrok Session.
Stop
A request from the ngrok dashboard for the agent to stop.
StopTunnel
A request from remote to stop a tunnel
Update
A request from the ngrok dashboard for the agent to update itself.

Enums§

ConnectError
Errors arising at SessionBuilder::connect time.
RpcError
Errors arising from tunneling protocol RPC calls.

Traits§

CommandHandler
Trait for a type that can handle a command from the ngrok dashboard.
Connector
Trait for establishing the connection to the ngrok server.
HeartbeatHandler
A handler called on every heartbeat with the latency for that beat.
IoStream
A trait alias for types that can provide the base ngrok transport, i.e. bidirectional byte streams.

Functions§

default_connect
The default ngrok connector.