entity

package
v0.19.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 18, 2026 License: MPL-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AuthRequest

type AuthRequest struct {
	PeerID string
	protocol.AuthPeer
	// SuggestedIP is a free IP address generated for this peer
	SuggestedIP string
}

Responses

type AvailableProxy added in v0.12.0

type AvailableProxy struct {
	PeerID    string
	PeerName  string
	Connected bool
}

Responses

type AvailableVPNGateway added in v0.18.0

type AvailableVPNGateway struct {
	PeerID    string
	PeerName  string
	Connected bool
}

Responses

type BandwidthDebugInfo

type BandwidthDebugInfo struct {
	Total      BandwidthInfo
	ByProtocol map[string]BandwidthInfo
}

type BandwidthInfo

type BandwidthInfo struct {
	TotalIn  string
	TotalOut string
	RateIn   string
	RateOut  string
}

type ConnectionsDebugInfo

type ConnectionsDebugInfo struct {
	ConnectedPeersCount  int
	OpenConnectionsCount int
	OpenStreamsCount     int64
	LastTrimAgo          string
}

type DhtDebugInfo

type DhtDebugInfo struct {
	RoutingTableSize    int
	RoutingTable        []kbucket.PeerInfo
	Reachability        string `enums:"Unknown,Public,Private"`
	ListenAddress       []string
	PeersWithAddrsCount int
	ReachableAddrs      []string
	UnreachableAddrs    []string
	UnknownAddrs        []string
	BootstrapPeers      map[string]p2p.BootstrapPeerDebugInfo
}

type EnableVPNGatewayClientRequest added in v0.18.0

type EnableVPNGatewayClientRequest struct {
	GatewayPeerID string `validate:"required"`
}

Responses

type FriendRequest

type FriendRequest struct {
	PeerID string `validate:"required"`
	Alias  string `validate:"required,trimmed_str_not_empty"`
	// optional: specific IP address for the peer
	IPAddr string `validate:"omitempty,ipv4"`
}

Requests

type FriendRequestReply

type FriendRequestReply struct {
	PeerID  string `validate:"required"`
	Alias   string `validate:"required,trimmed_str_not_empty"`
	Decline bool
	// optional: specific IP address for the peer
	IPAddr string `validate:"omitempty,ipv4"`
}

Requests

type GeneralDebugInfo

type GeneralDebugInfo struct {
	Version string
	Uptime  string
}

type KnownPeersResponse

type KnownPeersResponse struct {
	PeerID                        string
	Name                          string // Deprecated: use DisplayName instead
	DisplayName                   string // Deprecated: useless, equal to Alias all the time
	Alias                         string
	Version                       string
	IpAddr                        string
	DomainName                    string
	Connected                     bool
	Confirmed                     bool
	Declined                      bool
	WeAllowUsingAsExitNode        bool
	AllowedUsingAsExitNode        bool
	RemoteVPNGatewayServerEnabled bool
	LastSeen                      time.Time
	Connections                   []p2p.ConnectionInfo
	NetworkStats                  metrics.Stats
	NetworkStatsInIECUnits        StatsInUnits
	Ping                          time.Duration `swaggertype:"primitive,integer"`
}

Responses

type ListAvailableProxiesResponse added in v0.12.0

type ListAvailableProxiesResponse struct {
	Proxies []AvailableProxy
}

Responses

type ListAvailableVPNGatewaysResponse added in v0.18.0

type ListAvailableVPNGatewaysResponse struct {
	VPNGateways []AvailableVPNGateway
}

Responses

type LogRequest

type LogRequest struct {
	StartFromHead bool `url:"from_head" query:"from_head"`
	LogsRows      int  `url:"logs" query:"logs" validate:"numeric,gte=0"`
}

Requests

type P2pDebugInfo

type P2pDebugInfo struct {
	General     GeneralDebugInfo
	DHT         DhtDebugInfo
	Connections ConnectionsDebugInfo
	Bandwidth   BandwidthDebugInfo
	KnownPeers  []KnownPeersResponse
}

type PeerIDRequest

type PeerIDRequest struct {
	PeerID string `validate:"required"`
}

Requests

type PeerInfo

type PeerInfo struct {
	PeerID                  string
	Name                    string
	Uptime                  time.Duration `swaggertype:"primitive,integer"`
	ServerVersion           string
	NetworkStats            metrics.Stats
	NetworkStatsInIECUnits  StatsInUnits
	TotalBootstrapPeers     int
	ConnectedBootstrapPeers int
	Reachability            string `enums:"Unknown,Public,Private"`
	AwlDNSAddress           string
	IsAwlDNSSetAsSystem     bool
	VPN                     VPNInfo
	SOCKS5                  SOCKS5Info
	VPNGateway              VPNGatewayInfo
}

Responses

type SOCKS5Info added in v0.12.0

type SOCKS5Info struct {
	ListenAddress   string
	ProxyingEnabled bool
	ListenerEnabled bool
	// Connected — current libp2p connectivity to the exit peer.
	Connected             bool
	UsingPeerID           string
	UsingPeerName         string
	UsingPeerPublicIP     string
	UsingPeerPing         time.Duration `swaggertype:"primitive,integer"`
	UsingPeerThroughRelay bool
}

Responses

type SetVPNGatewayServerEnabledRequest added in v0.18.0

type SetVPNGatewayServerEnabledRequest struct {
	Enabled bool
}

Responses

type StatsInUnits

type StatsInUnits struct {
	TotalIn  string
	TotalOut string
	RateIn   string
	RateOut  string
}

Responses

type UpdateMySettingsRequest

type UpdateMySettingsRequest struct {
	Name string
}

Requests

type UpdatePeerSettingsRequest

type UpdatePeerSettingsRequest struct {
	PeerID     string `validate:"required"`
	Alias      string `validate:"required,trimmed_str_not_empty"`
	DomainName string `validate:"required,trimmed_str_not_empty"`
	// TODO: support ipv6
	IPAddr               string `validate:"required,ipv4"`
	AllowUsingAsExitNode bool
}

Requests

type UpdateProxySettingsRequest added in v0.12.0

type UpdateProxySettingsRequest struct {
	UsingPeerID string
}

Requests

type VPNGatewayInfo added in v0.18.0

type VPNGatewayInfo struct {
	// ClientEnabled — VPN gateway client mode is on (we route via GatewayPeerID).
	ClientEnabled bool
	// GatewayPeerID — the peer we route through; empty when disabled.
	GatewayPeerID string
	// GatewayPeerName — display name of the gateway peer, populated when known.
	GatewayPeerName string
	// Connected — current libp2p connectivity to the gateway peer.
	Connected bool
	// ServerEnabled — this node currently offers VPN gateway server.
	ServerEnabled       bool
	GatewayPublicIP     string
	GatewayPing         time.Duration `swaggertype:"primitive,integer"`
	GatewayThroughRelay bool
}

Responses

type VPNInfo added in v0.16.0

type VPNInfo struct {
	VPNInterfaceEnabled bool
	InterfaceName       string
	IPNet               string
}

Responses

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL