entity

Documentation

Index

• type AuthRequest
• type BandwidthDebugInfo
• type BandwidthInfo
• type ConnectionsDebugInfo
• type DhtDebugInfo
• type FriendRequest
• type FriendRequestReply
• type GeneralDebugInfo
• type KnownPeersResponse
• type LogRequest
• type P2pDebugInfo
• type PeerIDRequest
• type PeerInfo
• type StatsInUnits
• type UpdateMySettingsRequest
• type UpdatePeerSettingsRequest

Types

type AuthRequest

type AuthRequest struct {
	PeerID string
	protocol.AuthPeer
}

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
	ObservedAddrs       []string
	BootstrapPeers      map[string]p2p.BootstrapPeerDebugInfo
}

type FriendRequest

type FriendRequest struct {
	PeerID string `validate:"required"`
	Alias  string `validate:"required,trimmed_str_not_empty"`
}

Requests

type FriendRequestReply

type FriendRequestReply struct {
	PeerID  string `validate:"required"`
	Alias   string `validate:"required,trimmed_str_not_empty"`
	Decline bool
}

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
	LastSeen               time.Time
	Connections            []p2p.ConnectionInfo
	NetworkStats           metrics.Stats
	NetworkStatsInIECUnits StatsInUnits
}

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
}

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
}

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
	AllowUsingAsExitNode bool
}

Requests