host

package
v0.0.0-...-a39cba4 Latest Latest
Warning

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

 Go to latest Published: Nov 28, 2024 License: Apache-2.0, MIT Imports: 30 Imported by: 2

Documentation

Index

Constants

View Source 
const PeerScoreEventType = "PEERSCORE"

Variables

This section is empty.

Functions

func EventTypeFromBeaconChainProtocol 

func EventTypeFromBeaconChainProtocol(protocol string) string

EventTypeFromBeaconChainProtocol returns the event type for a given protocol string.

func MaddrFrom 

func MaddrFrom(ip string, port uint) (ma.Multiaddr, error)

MaddrFrom takes in an ip address string and port to produce a go multiaddr format.

func NoopHandler 

func NoopHandler(ctx context.Context, msg *pubsub.Message) error

Types

type CallbackDataStream 

type CallbackDataStream struct {
	// contains filtered or unexported fields
}

CallbackDataStream is a simple implementation of DataStream that holds a callback function. Users of CallbackDataStream should ensure that the callback function does not block, as blocking can delay or disrupt the processing of subsequent events.

func NewCallbackDataStream 

func NewCallbackDataStream() *CallbackDataStream

NewCallbackDataStream creates a new instance of CallbackDataStream.

func (*CallbackDataStream) OnEvent 

func (c *CallbackDataStream) OnEvent(onRecord func(ctx context.Context, event *TraceEvent))

OnEvent sets the callback function that will be called when an event is received.

func (*CallbackDataStream) OutputType 

func (c *CallbackDataStream) OutputType() DataStreamOutputType

OutputType returns the output type to be used by this data stream.

func (*CallbackDataStream) PutRecord 

func (c *CallbackDataStream) PutRecord(ctx context.Context, event *TraceEvent) error

PutRecord sends an event to the callback if the stream has not been stopped.

func (*CallbackDataStream) Start 

func (c *CallbackDataStream) Start(ctx context.Context) error

Start begins the data stream's operations.

func (*CallbackDataStream) Stop 

func (c *CallbackDataStream) Stop(ctx context.Context) error

Stop ends the data stream's operation.

func (*CallbackDataStream) Type 

func (c *CallbackDataStream) Type() DataStreamType

Type returns the type of the data stream, which is DataStreamTypeCallback.

type Config 

type Config struct {
	DataStream            DataStream
	PeerscoreSnapshotFreq time.Duration

	// Telemetry accessors
	Tracer trace.Tracer
	Meter  metric.Meter
}

type DataStream 

type DataStream interface {
	Start(ctx context.Context) error
	Stop(ctx context.Context) error
	PutRecord(ctx context.Context, event *TraceEvent) error
	Type() DataStreamType
	OutputType() DataStreamOutputType
}

type DataStreamOutputType 

type DataStreamOutputType int

DataStreamOutputType is the output type of the data stream. 

const (
	// DataStreamOutputTypeKinesis outputs the data stream decorated with metadata and in a format ingested by Kinesis.
	DataStreamOutputTypeKinesis DataStreamOutputType = iota
	// DataStreamOutputTypeFull outputs the data stream decorated with metadata and containing the raw/full event data.
	DataStreamOutputTypeFull
)

type DataStreamRenderer 

type DataStreamRenderer interface {
	RenderPayload(evt *TraceEvent, msg *pubsub.Message, dst ssz.Unmarshaler) (*TraceEvent, error)
}

DataStreamRenderer is an interface to support rendering a data-stream message into a destination.

type DataStreamType 

type DataStreamType int
const (
	DataStreamTypeKinesis DataStreamType = iota
	DataStreamTypeCallback
	DataStreamTypeLogger
)

func DataStreamtypeFromStr 

func DataStreamtypeFromStr(str string) DataStreamType

func (DataStreamType) String 

func (ds DataStreamType) String() string

type Host 

type Host struct {
	host.Host
	// contains filtered or unexported fields
}

func New 

func New(cfg *Config, opts ...libp2p.Option) (*Host, error)

func (*Host) AddPeer 

func (h *Host) AddPeer(p peer.ID, proto protocol.ID)

func (*Host) AgentVersion 

func (h *Host) AgentVersion(pid peer.ID) string

AgentVersion returns the agent version of the given peer. If the agent version is not known, it returns an empty string.

func (*Host) ConnSignal 

func (h *Host) ConnSignal(ctx context.Context, pid peer.ID) chan error

ConnSignal signals the incoming connection of the given peer on the returned channel by just closing it. Alternatively, if the context has a deadline that's exceeded, the channel will emit the context error and then be closed.

func (*Host) DeliverMessage 

func (h *Host) DeliverMessage(msg *pubsub.Message)

func (*Host) DropRPC 

func (h *Host) DropRPC(rpc *pubsub.RPC, p peer.ID)

func (*Host) DuplicateMessage 

func (h *Host) DuplicateMessage(msg *pubsub.Message)

func (*Host) FlushTrace 

func (h *Host) FlushTrace(evtType string, payload any)

func (*Host) FlushTraceWithTimestamp 

func (h *Host) FlushTraceWithTimestamp(evtType string, timestamp time.Time, payload any)

func (*Host) Graft 

func (h *Host) Graft(p peer.ID, topic string)

func (*Host) InitGossipSub 

func (h *Host) InitGossipSub(ctx context.Context, opts ...pubsub.Option) (*pubsub.PubSub, error)

func (*Host) Join 

func (h *Host) Join(topic string)

func (*Host) Leave 

func (h *Host) Leave(topic string)

func (*Host) LocalListenMaddr 

func (h *Host) LocalListenMaddr() (ma.Multiaddr, error)

LocalListenMaddr returns the first multiaddress in a localhost IP range that this host is listening on.

func (*Host) PrivateListenMaddr 

func (h *Host) PrivateListenMaddr() (ma.Multiaddr, error)

PrivateListenMaddr returns the first multiaddress in a private IP range that this host is listening on.

func (*Host) Prune 

func (h *Host) Prune(p peer.ID, topic string)

func (*Host) RecvRPC 

func (h *Host) RecvRPC(rpc *pubsub.RPC)

func (*Host) RejectMessage 

func (h *Host) RejectMessage(msg *pubsub.Message, reason string)

func (*Host) RemovePeer 

func (h *Host) RemovePeer(p peer.ID)

func (*Host) SendRPC 

func (h *Host) SendRPC(rpc *pubsub.RPC, p peer.ID)

func (*Host) Serve 

func (h *Host) Serve(ctx context.Context) error

func (*Host) ThrottlePeer 

func (h *Host) ThrottlePeer(p peer.ID)

func (*Host) Trace 

func (h *Host) Trace(evt *pubsubpb.TraceEvent)

func (*Host) TracedTopicHandler 

func (h *Host) TracedTopicHandler(handler TopicHandler) TopicHandler

func (*Host) UndeliverableMessage 

func (h *Host) UndeliverableMessage(msg *pubsub.Message)

func (*Host) UpdatePeerScore 

func (h *Host) UpdatePeerScore(scores map[peer.ID]*pubsub.PeerScoreSnapshot)

func (*Host) ValidateMessage 

func (h *Host) ValidateMessage(msg *pubsub.Message)

func (*Host) WaitForPublicAddress 

func (h *Host) WaitForPublicAddress(ctx context.Context) error

WaitForPublicAddress blocks until the libp2p host has identified its own addresses at which its publicly reachable.

type KinesisDataStream 

type KinesisDataStream struct {
	// contains filtered or unexported fields
}

func NewKinesisDataStream 

func NewKinesisDataStream(p *gk.Producer) *KinesisDataStream

NewKinesisDataStream creates a new instance of KinesisDataStream with a given producer.

func (*KinesisDataStream) OutputType 

func (k *KinesisDataStream) OutputType() DataStreamOutputType

OutputType returns the output type to be used by this data stream.

func (*KinesisDataStream) PutRecord 

func (k *KinesisDataStream) PutRecord(ctx context.Context, event *TraceEvent) error

PutRecord sends an event to the Kinesis data stream.

func (*KinesisDataStream) Start 

func (k *KinesisDataStream) Start(ctx context.Context) error

Start begins the data stream's operation.

func (*KinesisDataStream) Stop 

func (k *KinesisDataStream) Stop(ctx context.Context) error

Stop ends the data stream.

func (*KinesisDataStream) Type 

func (k *KinesisDataStream) Type() DataStreamType

Type returns the type of the data stream

type RpcControlGraft 

type RpcControlGraft struct {
	TopicID string
}

type RpcControlIHave 

type RpcControlIHave struct {
	TopicID string
	MsgIDs  []string
}

type RpcControlIWant 

type RpcControlIWant struct {
	MsgIDs []string
}

type RpcControlIdontWant 

type RpcControlIdontWant struct {
	MsgIDs []string
}

type RpcControlPrune 

type RpcControlPrune struct {
	TopicID string
	PeerIDs []peer.ID
}

type RpcMeta 

type RpcMeta struct {
	PeerID        peer.ID
	Subscriptions []RpcMetaSub    `json:"Subs,omitempty"`
	Messages      []RpcMetaMsg    `json:"Msgs,omitempty"`
	Control       *RpcMetaControl `json:"Control,omitempty"`
}

type RpcMetaControl 

type RpcMetaControl struct {
	IHave     []RpcControlIHave     `json:"IHave,omitempty"`
	IWant     []RpcControlIWant     `json:"IWant,omitempty"`
	Graft     []RpcControlGraft     `json:"Graft,omitempty"`
	Prune     []RpcControlPrune     `json:"Prune,omitempty"`
	Idontwant []RpcControlIdontWant `json:"Idontwant,omitempty"`
}

type RpcMetaMsg 

type RpcMetaMsg struct {
	MsgID string `json:"MsgID,omitempty"`
	Topic string `json:"Topic,omitempty"`
}

type RpcMetaSub 

type RpcMetaSub struct {
	Subscribe bool
	TopicID   string
}

type ScoreKeeper 

type ScoreKeeper struct {
	// contains filtered or unexported fields
}

ScoreKeeper is a thread-safe local copy of the score per peer and per copy TODO: figure out if this is some sort of info that we want to expose through OpenTelemetry (Still good to have it)

func (*ScoreKeeper) Get 

func (sk *ScoreKeeper) Get() map[peer.ID]*pubsub.PeerScoreSnapshot

func (*ScoreKeeper) Update 

func (sk *ScoreKeeper) Update(scores map[peer.ID]*pubsub.PeerScoreSnapshot)

type TopicHandler 

type TopicHandler = func(context.Context, *pubsub.Message) error

type TopicScore 

type TopicScore struct {
	Topic                    string
	TimeInMesh               time.Duration
	FirstMessageDeliveries   float64
	MeshMessageDeliveries    float64
	InvalidMessageDeliveries float64
}

type TopicSubscription 

type TopicSubscription struct {
	Topic   string
	LocalID peer.ID
	Sub     *pubsub.Subscription
	Handler TopicHandler
}

func (*TopicSubscription) Serve 

func (t *TopicSubscription) Serve(ctx context.Context) error

type TraceEvent 

type TraceEvent struct {
	Type      string
	Topic     string
	PeerID    peer.ID
	Timestamp time.Time
	Payload   any `json:"Data"` // cannot use field "Data" because of gk.Record method
}

func (*TraceEvent) Data 

func (t *TraceEvent) Data() []byte

func (*TraceEvent) ExplicitHashKey 

func (t *TraceEvent) ExplicitHashKey() *string

func (*TraceEvent) PartitionKey 

func (t *TraceEvent) PartitionKey() string

type TraceEventPayloadMetaData 

type TraceEventPayloadMetaData struct {
	PeerID  string `json:"PeerID"`
	Topic   string `json:"Topic"`
	Seq     []byte `json:"Seq"`
	MsgID   string `json:"MsgID"`
	MsgSize int    `json:"MsgSize"`
}

type TraceEventPeerScore 

type TraceEventPeerScore struct {
	PeerID             string
	Score              float64
	AppSpecificScore   float64
	IPColocationFactor float64
	BehaviourPenalty   float64
	Topics             []TopicScore
}

type TraceLogger 

type TraceLogger struct{}

func (*TraceLogger) OutputType 

func (t *TraceLogger) OutputType() DataStreamOutputType

OutputType returns the output type to be used by this data stream.

func (*TraceLogger) PutRecord 

func (t *TraceLogger) PutRecord(ctx context.Context, event *TraceEvent) error

func (*TraceLogger) Start 

func (t *TraceLogger) Start(ctx context.Context) error

func (*TraceLogger) Stop 

func (t *TraceLogger) Stop(ctx context.Context) error

func (*TraceLogger) Type 

func (t *TraceLogger) Type() DataStreamType

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.