introspection

package
v0.20.1 Latest Latest
Warning

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

Go to latest
Published: Sep 6, 2022 License: Apache-2.0, MIT, Apache-2.0, + 1 more Imports: 1 Imported by: 2

Documentation

Overview

Deprecated: This package has moved into go-libp2p as a sub-package: github.com/libp2p/go-libp2p/core/introspection.

Package introspection is EXPERIMENTAL. It is subject to heavy change, and it WILL change. For now, it is the simplest implementation to power the proof-of-concept of the libp2p introspection framework.

Package introspect contains the abstract skeleton of the introspection system of go-libp2p, and holds the introspection data schema.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Endpoint

type Endpoint = introspection.Endpoint

Endpoint is the interface to be implemented by introspection endpoints.

An introspection endpoint makes introspection data accessible to external consumers, over, for example, WebSockets, or TCP, or libp2p itself.

Experimental. Deprecated: use github.com/libp2p/go-libp2p/core/introspection.Endpoint instead

type Introspector

type Introspector = introspection.Introspector

Introspector is the interface to be satisfied by components that are capable of spelunking the state of the system, and representing in accordance with the introspection schema.

It's very rare to build a custom implementation of this interface; it exists mostly for mocking. In most cases, you'll end up using the default introspector.

Introspector implementations are usually injected in introspection endpoints to serve the data to clients, but they can also be used separately for embedding or testing.

Experimental. Deprecated: use github.com/libp2p/go-libp2p/core/introspection.Introspector instead

type Session

type Session = introspection.Session

Session represents an introspection session. Deprecated: use github.com/libp2p/go-libp2p/core/introspection.Session instead

Jump to

Keyboard shortcuts

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