Crate ts_control 

ts_control

Client for the Tailscale control plane.

Re-exports

pub use client::FilterUpdate;

pub use client::PeerUpdate;

pub use client::RegistrationError;

pub use client::StateUpdate;

pub use client::connect;

pub use client::register;

Modules

client

Functionality for connecting to and communicating with the Tailscale control server.

Structs

Config

Configuration for the control server.

ControlDialer

Manages state for control dial plan and handles selection of successive dial candidates.

DEFAULT_CONTROL_SERVER

The default Url of the control plane server (aka “coordination server”).

DerpRegion

A single derp Region, holding the region info and all the server info.

DialCandidate

A candidate endpoint for a control plane connection.

Endpoint

An endpoint (address + port) on which a peer can be reached.

MapRequest

Sent by a Tailscale node to the control server to either update the control plane about its current state, or to start a long-poll of network map updates. Includes a copy of the node’s current set of WireGuard endpoints and general host information.

MapRequestBuilder

Builder type for MapRequests; smooths over the annoying parts of creating a request.

Node

A node in a tailnet.

NodeLastSeen

Timestamps indicating when an offline node was last connected to the control plane. Only applies to nodes that are offline (disconnected from the control plane).

NodeUpdate

A partial update to a Node in a tailnet.

StableNodeId

The stable ID of a node.

TailnetAddress

Addresses for a node within a tailnet.

Enums

DialMode

The mode with which to connect to the control plane.

DialPlan

A plan to connect to the control plane, supplied as part of a netmap update.

EndpointType

Distinguishes different sources of MapRequest::endpoints values.

Error

An error which occurred while connecting to the control server or control plane.

InternalErrorKind

What kind of internal error has occurred.

NodeStatus

Whether a node is online (connected to the control plane) or offline (disconnected from the control plane).

Operation

The phase of connecting the control plane to a Tailnet in which an error occurs.

Constants

PKG_VERSION

Package version of ts_control as reported by cargo.

Statics

DEFAULT_CONTROL_SERVER

Traits

TcpDialer

Creates a TCP connection on the basis of a specific DialCandidate.

Functions

complete_connection

Complete a connection to control over the supplied I/O stream.

convert_derp_map

Convert a derp map from the ts_control_serde representation to the ts_derp representation.

Type Aliases

DerpMap

The full derp state, a map of ts_derp::RegionIds to Regions.

NodeId

The unique id of a node.