common

Documentation

Index

• type CommonAPI
  • func (a *CommonAPI) AuthNew(ctx context.Context, perms []auth.Permission) ([]byte, error)
  • func (a *CommonAPI) AuthVerify(ctx context.Context, token string) ([]auth.Permission, error)
  • func (a *CommonAPI) Closing(ctx context.Context) (<-chan struct{}, error)
  • func (a *CommonAPI) Discover(ctx context.Context) (apitypes.OpenRPCDocument, error)
  • func (a *CommonAPI) ID(context.Context) (peer.ID, error)
  • func (a *CommonAPI) LogList(context.Context) ([]string, error)
  • func (a *CommonAPI) LogSetLevel(ctx context.Context, subsystem, level string) error
  • func (a *CommonAPI) NetAddrsListen(context.Context) (peer.AddrInfo, error)
  • func (a *CommonAPI) NetAgentVersion(ctx context.Context, p peer.ID) (string, error)
  • func (a *CommonAPI) NetAutoNatStatus(ctx context.Context) (i api.NatInfo, err error)
  • func (a *CommonAPI) NetBandwidthStats(ctx context.Context) (metrics.Stats, error)
  • func (a *CommonAPI) NetBandwidthStatsByPeer(ctx context.Context) (map[string]metrics.Stats, error)
  • func (a *CommonAPI) NetBandwidthStatsByProtocol(ctx context.Context) (map[protocol.ID]metrics.Stats, error)
  • func (a *CommonAPI) NetBlockAdd(ctx context.Context, acl api.NetBlockList) error
  • func (a *CommonAPI) NetBlockList(ctx context.Context) (result api.NetBlockList, err error)
  • func (a *CommonAPI) NetBlockRemove(ctx context.Context, acl api.NetBlockList) error
  • func (a *CommonAPI) NetConnect(ctx context.Context, p peer.AddrInfo) error
  • func (a *CommonAPI) NetConnectedness(ctx context.Context, pid peer.ID) (network.Connectedness, error)
  • func (a *CommonAPI) NetDisconnect(ctx context.Context, p peer.ID) error
  • func (a *CommonAPI) NetFindPeer(ctx context.Context, p peer.ID) (peer.AddrInfo, error)
  • func (a *CommonAPI) NetPeerInfo(_ context.Context, p peer.ID) (*api.ExtendedPeerInfo, error)
  • func (a *CommonAPI) NetPeers(context.Context) ([]peer.AddrInfo, error)
  • func (a *CommonAPI) NetPubsubScores(context.Context) ([]api.PubsubScore, error)
  • func (a *CommonAPI) Session(ctx context.Context) (uuid.UUID, error)
  • func (a *CommonAPI) Shutdown(ctx context.Context) error
  • func (a *CommonAPI) Version(context.Context) (api.APIVersion, error)

Types

type CommonAPI

type CommonAPI struct {
	fx.In

	APISecret    *dtypes.APIAlg
	RawHost      lp2p.RawHost
	Host         host.Host
	Router       lp2p.BaseIpfsRouting
	ConnGater    *conngater.BasicConnectionGater
	Reporter     metrics.Reporter
	Sk           *dtypes.ScoreKeeper
	ShutdownChan dtypes.ShutdownChan
}

func (*CommonAPI) AuthNew

func (a *CommonAPI) AuthNew(ctx context.Context, perms []auth.Permission) ([]byte, error)

func (*CommonAPI) AuthVerify

func (a *CommonAPI) AuthVerify(ctx context.Context, token string) ([]auth.Permission, error)

func (*CommonAPI) Closing

func (a *CommonAPI) Closing(ctx context.Context) (<-chan struct{}, error)

func (*CommonAPI) Discover

func (a *CommonAPI) Discover(ctx context.Context) (apitypes.OpenRPCDocument, error)

func (*CommonAPI) ID

func (a *CommonAPI) ID(context.Context) (peer.ID, error)

func (*CommonAPI) LogList

func (a *CommonAPI) LogList(context.Context) ([]string, error)

func (*CommonAPI) LogSetLevel

func (a *CommonAPI) LogSetLevel(ctx context.Context, subsystem, level string) error

func (*CommonAPI) NetAddrsListen

func (a *CommonAPI) NetAddrsListen(context.Context) (peer.AddrInfo, error)

func (*CommonAPI) NetAgentVersion

func (a *CommonAPI) NetAgentVersion(ctx context.Context, p peer.ID) (string, error)

func (*CommonAPI) NetAutoNatStatus

func (a *CommonAPI) NetAutoNatStatus(ctx context.Context) (i api.NatInfo, err error)

func (*CommonAPI) NetBandwidthStats

func (a *CommonAPI) NetBandwidthStats(ctx context.Context) (metrics.Stats, error)

func (*CommonAPI) NetBandwidthStatsByPeer

func (a *CommonAPI) NetBandwidthStatsByPeer(ctx context.Context) (map[string]metrics.Stats, error)

func (*CommonAPI) NetBandwidthStatsByProtocol

func (a *CommonAPI) NetBandwidthStatsByProtocol(ctx context.Context) (map[protocol.ID]metrics.Stats, error)

func (*CommonAPI) NetBlockAdd

func (a *CommonAPI) NetBlockAdd(ctx context.Context, acl api.NetBlockList) error

func (*CommonAPI) NetBlockList

func (a *CommonAPI) NetBlockList(ctx context.Context) (result api.NetBlockList, err error)

func (*CommonAPI) NetBlockRemove

func (a *CommonAPI) NetBlockRemove(ctx context.Context, acl api.NetBlockList) error

func (*CommonAPI) NetConnect

func (a *CommonAPI) NetConnect(ctx context.Context, p peer.AddrInfo) error

func (*CommonAPI) NetConnectedness

func (a *CommonAPI) NetConnectedness(ctx context.Context, pid peer.ID) (network.Connectedness, error)

func (*CommonAPI) NetDisconnect

func (a *CommonAPI) NetDisconnect(ctx context.Context, p peer.ID) error

func (*CommonAPI) NetFindPeer

func (a *CommonAPI) NetFindPeer(ctx context.Context, p peer.ID) (peer.AddrInfo, error)

func (*CommonAPI) NetPeerInfo

func (a *CommonAPI) NetPeerInfo(_ context.Context, p peer.ID) (*api.ExtendedPeerInfo, error)

func (*CommonAPI) NetPeers

func (a *CommonAPI) NetPeers(context.Context) ([]peer.AddrInfo, error)

func (*CommonAPI) NetPubsubScores

func (a *CommonAPI) NetPubsubScores(context.Context) ([]api.PubsubScore, error)

func (*CommonAPI) Session

func (a *CommonAPI) Session(ctx context.Context) (uuid.UUID, error)

func (*CommonAPI) Shutdown

func (a *CommonAPI) Shutdown(ctx context.Context) error

func (*CommonAPI) Version

func (a *CommonAPI) Version(context.Context) (api.APIVersion, error)